]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - UPDATING
There are several code sequences like
[FreeBSD/FreeBSD.git] / UPDATING
1 Updating Information for FreeBSD current users
2
3 This file is maintained and copyrighted by M. Warner Losh <imp@freebsd.org>.
4 See end of file for further details.  For commonly done items, please see the
5 COMMON ITEMS: section later in the file.  These instructions assume that you
6 basically know what you are doing.  If not, then please consult the FreeBSD
7 handbook:
8
9     http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
10
11 Items affecting the ports and packages system can be found in
12 /usr/ports/UPDATING.  Please read that file before running portupgrade.
13
14 NOTE: FreeBSD has switched from gcc to clang. If you have trouble bootstrapping
15 from older versions of FreeBSD, try WITHOUT_CLANG to bootstrap to the tip of
16 head, and then rebuild without this option. The bootstrap process from
17 older version of current is a bit fragile.
18
19 NOTE TO PEOPLE WHO THINK THAT FreeBSD 10.x IS SLOW:
20         FreeBSD 10.x has many debugging features turned on, in both the kernel
21         and userland.  These features attempt to detect incorrect use of
22         system primitives, and encourage loud failure through extra sanity
23         checking and fail stop semantics.  They also substantially impact
24         system performance.  If you want to do performance measurement,
25         benchmarking, and optimization, you'll want to turn them off.  This
26         includes various WITNESS- related kernel options, INVARIANTS, malloc
27         debugging flags in userland, and various verbose features in the
28         kernel.  Many developers choose to disable these features on build
29         machines to maximize performance.  (To completely disable malloc
30         debugging, define MALLOC_PRODUCTION in /etc/make.conf, or to merely
31         disable the most expensive debugging functionality run
32         "ln -s 'abort:false,junk:false' /etc/malloc.conf".)
33
34 20130709:
35         Most of network statistics structures were changed to be able
36         keep 64-bits counters. Thus all tools, that work with networking
37         statistics, must be rebuilded (netstat(1), bsnmpd(1), etc.)
38
39 20130629:
40         Fix targets that run multiple make's to use && rather than ;
41         so that subsequent steps depend on success of previous.
42
43         NOTE: if building 'universe' with -j* on stable/8 or stable/9
44         it would be better to start the build using bmake, to avoid
45         overloading the machine.
46
47 20130618:
48         Fix a bug that allowed a tracing process (e.g. gdb) to write
49         to a memory-mapped file in the traced process's address space
50         even if neither the traced process nor the tracing process had
51         write access to that file.
52
53 20130615:
54         CVS has been removed from the base system.  An exact copy
55         of the code is available from the devel/cvs port.
56
57 20130613:
58         Some people report the following error after the switch to bmake:
59
60                 make: illegal option -- J
61                 usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
62                         ...
63                 *** [buildworld] Error code 2
64
65         this likely due to an old instance of make in
66         ${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
67         which src/Makefile will use that blindly, if it exists, so if
68         you see the above error:
69
70                 rm -rf `make -V MAKEPATH`
71
72         should resolve it.
73
74 20130516:
75         Use bmake by default.
76         Whereas before one could choose to build with bmake via
77         -DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
78         make. The goal is to remove these knobs for 10-RELEASE.
79
80         It is worth noting that bmake (like gmake) treats the command
81         line as the unit of failure, rather than statements within the
82         command line.  Thus '(cd some/where && dosomething)' is safer
83         than 'cd some/where; dosomething'. The '()' allows consistent
84         behavior in parallel build.
85
86 20130429:
87         Fix a bug that allows NFS clients to issue READDIR on files.
88
89 20130426:
90         The WITHOUT_IDEA option has been removed because
91         the IDEA patent expired.
92
93 20130426:
94         The sysctl which controls TRIM support under ZFS has been renamed
95         from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
96         enabled by default.
97
98 20130425:
99         The mergemaster command now uses the default MAKEOBJDIRPREFIX
100         rather than creating it's own in the temporary directory in
101         order allow access to bootstrapped versions of tools such as
102         install and mtree.  When upgrading from version of FreeBSD where
103         the install command does not support -l, you will need to
104         install a new mergemaster command if mergemaster -p is required.
105         This can be accomplished with the command (cd src/usr.sbin/mergemaster
106         && make install).
107
108 20130404:
109         Legacy ATA stack, disabled and replaced by new CAM-based one since
110         FreeBSD 9.0, completely removed from the sources.  Kernel modules
111         atadisk and atapi*, user-level tools atacontrol and burncd are
112         removed.  Kernel option `options ATA_CAM` is now permanently enabled
113         and removed.
114
115 20130319:
116         SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
117         and socketpair(2). Software, in particular Kerberos, may
118         automatically detect and use these during building. The resulting
119         binaries will not work on older kernels.
120
121 20130308:
122         CTL_DISABLE has also been added to the sparc64 GENERIC (for further
123         information, see the respective 20130304 entry).
124
125 20130304:
126         Recent commits to callout(9) changed the size of struct callout,
127         so the KBI is probably heavily disturbed. Also, some functions
128         in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
129         by macros. Every kernel module using it won't load, so rebuild
130         is requested.
131
132         The ctl device has been re-enabled in GENERIC for i386 and amd64,
133         but does not initialize by default (because of the new CTL_DISABLE
134         option) to save memory.  To re-enable it, remove the CTL_DISABLE
135         option from the kernel config file or set kern.cam.ctl.disable=0
136         in /boot/loader.conf.
137
138 20130301:
139         The ctl device has been disabled in GENERIC for i386 and amd64.
140         This was done due to the extra memory being allocated at system
141         initialisation time by the ctl driver which was only used if
142         a CAM target device was created.  This makes a FreeBSD system
143         unusable on 128MB or less of RAM.
144
145 20130208:
146         A new compression method (lz4) has been merged to -HEAD.  Please
147         refer to zpool-features(7) for more information.
148
149         Please refer to the "ZFS notes" section of this file for information
150         on upgrading boot ZFS pools.
151
152 20130129:
153         A BSD-licensed patch(1) variant has been added and is installed
154         as bsdpatch, being the GNU version the default patch.
155         To inverse the logic and use the BSD-licensed one as default,
156         while having the GNU version installed as gnupatch, rebuild
157         and install world with the WITH_BSD_PATCH knob set.
158
159 20130121:
160         Due to the use of the new -l option to install(1) during build
161         and install, you must take care not to directly set the INSTALL
162         make variable in your /etc/make.conf, /etc/src.conf, or on the
163         command line.  If you wish to use the -C flag for all installs
164         you may be able to add INSTALL+=-C to /etc/make.conf or
165         /etc/src.conf.
166
167 20130118:
168         The install(1) option -M has changed meaning and now takes an
169         argument that is a file or path to append logs to.  In the
170         unlikely event that -M was the last option on the command line
171         and the command line contained at least two files and a target
172         directory the first file will have logs appended to it.  The -M
173         option served little practical purpose in the last decade so its
174         use is expected to be extremely rare.
175
176 20121223:
177         After switching to Clang as the default compiler some users of ZFS
178         on i386 systems started to experience stack overflow kernel panics.
179         Please consider using 'options KSTACK_PAGES=4' in such configurations.
180
181 20121222:
182         GEOM_LABEL now mangles label names read from file system metadata.
183         Mangling affect labels containing spaces, non-printable characters,
184         '%' or '"'. Device names in /etc/fstab and other places may need to
185         be updated.
186
187 20121217:
188         By default, only the 10 most recent kernel dumps will be saved.  To
189         restore the previous behaviour (no limit on the number of kernel dumps
190         stored in the dump directory) add the following line to /etc/rc.conf:
191
192                 savecore_flags=""
193
194 20121201:
195         With the addition of auditdistd(8), a new auditdistd user is now
196         depended on during installworld.  "mergemaster -p" can be used to add
197         the user prior to installworld, as documented in the handbook.
198
199 20121117:
200         The sin6_scope_id member variable in struct sockaddr_in6 is now
201         filled by the kernel before passing the structure to the userland via
202         sysctl or routing socket.  This means the KAME-specific embedded scope
203         id in sin6_addr.s6_addr[2] is always cleared in userland application.
204         This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
205         __FreeBSD_version is bumped to 1000025.
206
207 20121105:
208         On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
209         This means that the world and kernel will be compiled with clang
210         and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
211         and /usr/bin/cpp.  To disable this behavior and revert to building
212         with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
213         of current may need to bootstrap WITHOUT_CLANG first if the clang
214         build fails (its compatibility window doesn't extend to the 9 stable
215         branch point).
216
217 20121102:
218         The IPFIREWALL_FORWARD kernel option has been removed. Its
219         functionality now turned on by default.
220
221 20121023:
222         The ZERO_COPY_SOCKET kernel option has been removed and
223         split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
224         NB: SOCKET_SEND_COW uses the VM page based copy-on-write
225         mechanism which is not safe and may result in kernel crashes.
226         NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
227         driver supports disposeable external page sized mbuf storage.
228         Proper replacements for both zero-copy mechanisms are under
229         consideration and will eventually lead to complete removal
230         of the two kernel options.
231
232 20121023:
233         The IPv4 network stack has been converted to network byte
234         order. The following modules need to be recompiled together
235         with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
236         pf(4), ipfw(4), ng_ipfw(4), stf(4).
237
238 20121022:
239         Support for non-MPSAFE filesystems was removed from VFS. The
240         VFS_VERSION was bumped, all filesystem modules shall be
241         recompiled.
242
243 20121018:
244         All the non-MPSAFE filesystems have been disconnected from
245         the build. The full list includes: codafs, hpfs, ntfs, nwfs,
246         portalfs, smbfs, xfs.
247
248 20121016:
249         The interface cloning API and ABI has changed. The following
250         modules need to be recompiled together with kernel:
251         ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
252         vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
253         faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
254
255 20121015:
256         The sdhci driver was split in two parts: sdhci (generic SD Host
257         Controller logic) and sdhci_pci (actual hardware driver).
258         No kernel config modifications are required, but if you
259         load sdhc as a module you must switch to sdhci_pci instead.
260
261 20121014:
262         Import the FUSE kernel and userland support into base system.
263
264 20121013:
265         The GNU sort(1) program has been removed since the BSD-licensed
266         sort(1) has been the default for quite some time and no serious
267         problems have been reported.  The corresponding WITH_GNU_SORT
268         knob has also gone.
269
270 20121006:
271         The pfil(9) API/ABI for AF_INET family has been changed. Packet
272         filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
273         with new kernel.
274
275 20121001:
276         The net80211(4) ABI has been changed to allow for improved driver
277         PS-POLL and power-save support.  All wireless drivers need to be
278         recompiled to work with the new kernel.
279
280 20120913:
281         The random(4) support for the VIA hardware random number
282         generator (`PADLOCK') is no longer enabled unconditionally.
283         Add the PADLOCK_RNG option in the custom kernel config if
284         needed.  The GENERIC kernels on i386 and amd64 do include the
285         option, so the change only affects the custom kernel
286         configurations.
287
288 20120908:
289         The pf(4) packet filter ABI has been changed. pfctl(8) and
290         snmp_pf module need to be recompiled to work with new kernel.
291
292 20120828:
293         A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
294         to -HEAD. Pools that have empty_bpobj in active state can not be
295         imported read-write with ZFS implementations that do not support
296         this feature. For more information read the zpool-features(5)
297         manual page.
298
299 20120727:
300         The sparc64 ZFS loader has been changed to no longer try to auto-
301         detect ZFS providers based on diskN aliases but now requires these
302         to be explicitly listed in the OFW boot-device environment variable. 
303
304 20120712:
305         The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
306         libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
307         configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
308
309 20120712:
310         The following sysctls and tunables have been renamed for consistency
311         with other variables:
312           kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
313           kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
314
315 20120628:
316         The sort utility has been replaced with BSD sort.  For now, GNU sort
317         is also available as "gnusort" or the default can be set back to
318         GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
319         installed as "bsdsort".
320
321 20120611:
322         A new version of ZFS (pool version 5000) has been merged to -HEAD.
323         Starting with this version the old system of ZFS pool versioning
324         is superseded by "feature flags". This concept enables forward
325         compatibility against certain future changes in functionality of ZFS
326         pools. The first read-only compatible "feature flag" for ZFS pools
327         is named "com.delphix:async_destroy". For more information
328         read the new zpool-features(5) manual page.
329         Please refer to the "ZFS notes" section of this file for information
330         on upgrading boot ZFS pools.
331
332 20120417:
333         The malloc(3) implementation embedded in libc now uses sources imported
334         as contrib/jemalloc.  The most disruptive API change is to
335         /etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
336         delete it prior to installworld, and optionally re-create it using the
337         new format after rebooting.  See malloc.conf(5) for details
338         (specifically the TUNING section and the "opt.*" entries in the MALLCTL
339         NAMESPACE section).
340
341 20120328:
342         Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
343         is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
344         now spelled mips.  This is to aid compatibility with third-party
345         software that expects this naming scheme in uname(3).  Little-endian
346         settings are unchanged. If you are updating a big-endian mips64 machine
347         from before this change, you may need to set MACHINE_ARCH=mips64 in
348         your environment before the new build system will recognize your machine.
349
350 20120306:
351         Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
352         platforms.
353
354 20120229:
355         Now unix domain sockets behave "as expected" on nullfs(5). Previously
356         nullfs(5) did not pass through all behaviours to the underlying layer,
357         as a result if we bound to a socket on the lower layer we could connect
358         only to the lower path; if we bound to the upper layer we could connect
359         only to the upper path. The new behavior is one can connect to both the
360         lower and the upper paths regardless what layer path one binds to.
361
362 20120211:
363         The getifaddrs upgrade path broken with 20111215 has been restored.
364         If you have upgraded in between 20111215 and 20120209 you need to
365         recompile libc again with your kernel.  You still need to recompile
366         world to be able to configure CARP but this restriction already
367         comes from 20111215.
368
369 20120114:
370         The set_rcvar() function has been removed from /etc/rc.subr.  All
371         base and ports rc.d scripts have been updated, so if you have a
372         port installed with a script in /usr/local/etc/rc.d you can either
373         hand-edit the rcvar= line, or reinstall the port.
374
375         An easy way to handle the mass-update of /etc/rc.d:
376         rm /etc/rc.d/* && mergemaster -i
377
378 20120109:
379         panic(9) now stops other CPUs in the SMP systems, disables interrupts
380         on the current CPU and prevents other threads from running.
381         This behavior can be reverted using the kern.stop_scheduler_on_panic
382         tunable/sysctl.
383         The new behavior can be incompatible with kern.sync_on_panic.
384
385 20111215:
386         The carp(4) facility has been changed significantly. Configuration
387         of the CARP protocol via ifconfig(8) has changed, as well as format
388         of CARP events submitted to devd(8) has changed. See manual pages
389         for more information. The arpbalance feature of carp(4) is currently
390         not supported anymore.
391
392         Size of struct in_aliasreq, struct in6_aliasreq has changed. User
393         utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
394         need to be recompiled.
395
396 20111122:
397         The acpi_wmi(4) status device /dev/wmistat has been renamed to
398         /dev/wmistat0.
399
400 20111108:
401         The option VFS_ALLOW_NONMPSAFE option has been added in order to
402         explicitely support non-MPSAFE filesystems.
403         It is on by default for all supported platform at this present
404         time.
405
406 20111101:
407         The broken amd(4) driver has been replaced with esp(4) in the amd64,
408         i386 and pc98 GENERIC kernel configuration files.
409
410 20110930:
411         sysinstall has been removed
412
413 20110923:
414         The stable/9 branch created in subversion.  This corresponds to the
415         RELENG_9 branch in CVS.
416
417 20110913:
418         This commit modifies vfs_register() so that it uses a hash
419         calculation to set vfc_typenum, which is enabled by default.
420         The first time a system is booted after this change, the
421         vfc_typenum values will change for all file systems. The
422         main effect of this is a change to the NFS server file handles
423         for file systems that use vfc_typenum in their fsid, such as ZFS.
424         It will, however, prevent vfc_typenum from changing when file
425         systems are loaded in a different order for subsequent reboots.
426         To disable this, you can set vfs.typenumhash=0 in /boot/loader.conf
427         until you are ready to remount all NFS clients after a reboot.
428
429 20110828:
430         Bump the shared library version numbers for libraries that
431         do not use symbol versioning, have changed the ABI compared
432         to stable/8 and which shared library version was not bumped.
433         Done as part of 9.0-RELEASE cycle.
434
435 20110815:
436         During the merge of Capsicum features, the fget(9) KPI was modified.
437         This may require the rebuilding of out-of-tree device drivers --
438         issues have been reported specifically with the nVidia device driver.
439         __FreeBSD_version is bumped to 900041.
440
441         Also, there is a period between 20110811 and 20110814 where the
442         special devices /dev/{stdin,stdout,stderr} did not work correctly.
443         Building world from a kernel during that window may not work.
444
445 20110628:
446         The packet filter (pf) code has been updated to OpenBSD 4.5.
447         You need to update userland tools to be in sync with kernel.
448         This update breaks backward compatibility with earlier pfsync(4)
449         versions.  Care must be taken when updating redundant firewall setups.
450
451 20110608:
452         The following sysctls and tunables are retired on x86 platforms:
453                 machdep.hlt_cpus
454                 machdep.hlt_logical_cpus
455         The following sysctl is retired:
456                 machdep.hyperthreading_allowed
457         The sysctls were supposed to provide a way to dynamically offline and
458         online selected CPUs on x86 platforms, but the implementation has not
459         been reliable especially with SCHED_ULE scheduler.
460         machdep.hyperthreading_allowed tunable is still available to ignore
461         hyperthreading CPUs at OS level.
462         Individual CPUs can be disabled using hint.lapic.X.disabled tunable,
463         where X is an APIC ID of a CPU.  Be advised, though, that disabling
464         CPUs in non-uniform fashion will result in non-uniform topology and
465         may lead to sub-optimal system performance with SCHED_ULE, which is
466         a default scheduler.
467
468 20110607:
469         cpumask_t type is retired and cpuset_t is used in order to describe
470         a mask of CPUs.
471
472 20110531:
473         Changes to ifconfig(8) for dynamic address family detection mandate
474         that you are running a kernel of 20110525 or later.  Make sure to
475         follow the update procedure to boot a new kernel before installing
476         world.
477
478 20110513:
479         Support for sun4v architecture is officially dropped
480
481 20110503:
482         Several KPI breaking changes have been committed to the mii(4) layer,
483         the PHY drivers and consequently some Ethernet drivers using mii(4).
484         This means that miibus.ko and the modules of the affected Ethernet
485         drivers need to be recompiled.
486
487         Note to kernel developers: Given that the OUI bit reversion problem
488         was fixed as part of these changes all mii(4) commits related to OUIs,
489         i.e. to sys/dev/mii/miidevs, PHY driver probing and vendor specific
490         handling, no longer can be merged verbatim to stable/8 and previous
491         branches.
492
493 20110430:
494         Users of the Atheros AR71xx SoC code now need to add 'device ar71xx_pci'
495         into their kernel configurations along with 'device pci'.
496
497 20110427:
498         The default NFS client is now the new NFS client, so fstype "newnfs"
499         is now "nfs" and the regular/old NFS client is now fstype "oldnfs".
500         Although mounts via fstype "nfs" will usually work without userland
501         changes, it is recommended that the mount(8) and mount_nfs(8)
502         commands be rebuilt from sources and that a link to mount_nfs called
503         mount_oldnfs be created. The new client is compiled into the
504         kernel with "options NFSCL" and this is needed for diskless root
505         file systems. The GENERIC kernel configs have been changed to use
506         NFSCL and NFSD (the new server) instead of NFSCLIENT and NFSSERVER.
507         To use the regular/old client, you can "mount -t oldnfs ...". For
508         a diskless root file system, you must also include a line like:
509         
510         vfs.root.mountfrom="oldnfs:"
511
512         in the boot/loader.conf on the root fs on the NFS server to make
513         a diskless root fs use the old client.
514
515 20110424:
516         The GENERIC kernels for all architectures now default to the new
517         CAM-based ATA stack. It means that all legacy ATA drivers were
518         removed and replaced by respective CAM drivers. If you are using
519         ATA device names in /etc/fstab or other places, make sure to update
520         them respectively (adX -> adaY, acdX -> cdY, afdX -> daY, astX -> saY,
521         where 'Y's are the sequential numbers starting from zero for each type
522         in order of detection, unless configured otherwise with tunables,
523         see cam(4)). There will be symbolic links created in /dev/ to map
524         old adX devices to the respective adaY. They should provide basic
525         compatibility for file systems mounting in most cases, but they do
526         not support old user-level APIs and do not have respective providers
527         in GEOM. Consider using updated management tools with new device names.
528
529         It is possible to load devices ahci, ata, siis and mvs as modules,
530         but option ATA_CAM should remain in kernel configuration to make ata
531         module work as CAM driver supporting legacy ATA controllers. Device ata
532         still can be used in modular fashion (atacore + ...). Modules atadisk
533         and atapi* are not used and won't affect operation in ATA_CAM mode.
534         Note that to use CAM-based ATA kernel should include CAM devices
535         scbus, pass, da (or explicitly ada), cd and optionally others. All of
536         them are parts of the cam module.
537
538         ataraid(4) functionality is now supported by the RAID GEOM class.
539         To use it you can load geom_raid kernel module and use graid(8) tool
540         for management. Instead of /dev/arX device names, use /dev/raid/rX.
541
542         No kernel config options or code have been removed, so if a problem
543         arises, please report it and optionally revert to the old ATA stack.
544         In order to do it you can remove from the kernel config:
545             options        ATA_CAM
546             device         ahci
547             device         mvs
548             device         siis
549         , and instead add back:
550             device         atadisk         # ATA disk drives
551             device         ataraid         # ATA RAID drives
552             device         atapicd         # ATAPI CDROM drives
553             device         atapifd         # ATAPI floppy drives
554             device         atapist         # ATAPI tape drives
555
556 20110423:
557         The default NFS server has been changed to the new server, which
558         was referred to as the experimental server. If you need to switch
559         back to the old NFS server, you must now put the "-o" option on
560         both the mountd and nfsd commands. This can be done using the
561         mountd_flags and nfs_server_flags rc.conf variables until an
562         update to the rc scripts is committed, which is coming soon.
563
564 20110418:
565         The GNU Objective-C runtime library (libobjc), and other Objective-C
566         related components have been removed from the base system.  If you
567         require an Objective-C library, please use one of the available ports.
568
569 20110331:
570         ath(4) has been split into bus- and device- modules. if_ath contains
571         the HAL, the TX rate control and the network device code. if_ath_pci
572         contains the PCI bus glue. For Atheros MIPS embedded systems, if_ath_ahb
573         contains the AHB glue. Users need to load both if_ath_pci and if_ath
574         in order to use ath on everything else.
575
576         TO REPEAT: if_ath_ahb is not needed for normal users. Normal users only
577         need to load if_ath and if_ath_pci for ath(4) operation.
578
579 20110314:
580         As part of the replacement of sysinstall, the process of building
581         release media has changed significantly. For details, please re-read
582         release(7), which has been updated to reflect the new build process.
583
584 20110218:
585         GNU binutils 2.17.50 (as of 2007-07-03) has been merged to -HEAD.  This
586         is the last available version under GPLv2.  It brings a number of new
587         features, such as support for newer x86 CPU's (with SSE-3, SSSE-3, SSE
588         4.1 and SSE 4.2), better support for powerpc64, a number of new
589         directives, and lots of other small improvements.  See the ChangeLog
590         file in contrib/binutils for the full details.
591
592 20110218:
593         IPsec's HMAC_SHA256-512 support has been fixed to be RFC4868
594         compliant, and will now use half of hash for authentication.
595         This will break interoperability with all stacks (including all
596         actual FreeBSD versions) who implement
597         draft-ietf-ipsec-ciph-sha-256-00 (they use 96 bits of hash for
598         authentication).
599         The only workaround with such peers is to use another HMAC
600         algorithm for IPsec ("phase 2") authentication.
601
602 20110207:
603         Remove the uio_yield prototype and symbol.  This function has
604         been misnamed since it was introduced and should not be
605         globally exposed with this name.  The equivalent functionality
606         is now available using kern_yield(curthread->td_user_pri).
607         The function remains undocumented.
608
609 20110112:
610         A SYSCTL_[ADD_]UQUAD was added for unsigned uint64_t pointers,
611         symmetric with the existing SYSCTL_[ADD_]QUAD.  Type checking
612         for scalar sysctls is defined but disabled.  Code that needs
613         UQUAD to pass the type checking that must compile on older
614         systems where the define is not present can check against
615         __FreeBSD_version >= 900030.
616
617         The system dialog(1) has been replaced with a new version previously
618         in ports as devel/cdialog. dialog(1) is mostly command-line compatible
619         with the previous version, but the libdialog associated with it has
620         a largely incompatible API. As such, the original version of libdialog
621         will be kept temporarily as libodialog, until its base system consumers
622         are replaced or updated. Bump __FreeBSD_version to 900030.
623
624 20110103:
625         If you are trying to run make universe on a -stable system, and you get
626         the following warning:
627         "Makefile", line 356: "Target architecture for i386/conf/GENERIC 
628         unknown.  config(8) likely too old."
629         or something similar to it, then you must upgrade your -stable system
630         to 8.2-Release or newer (really, any time after r210146 7/15/2010 in
631         stable/8) or build the config from the latest stable/8 branch and
632         install it on your system.
633
634         Prior to this date, building a current universe on 8-stable system from
635         between 7/15/2010 and 1/2/2011 would result in a weird shell parsing
636         error in the first kernel build phase.  A new config on those old 
637         systems will fix that problem for older versions of -current.
638
639 20101228:
640         The TCP stack has been modified to allow Khelp modules to interact with
641         it via helper hook points and store per-connection data in the TCP
642         control block. Bump __FreeBSD_version to 900029. User space tools that
643         rely on the size of struct tcpcb in tcp_var.h (e.g. sockstat) need to
644         be recompiled.
645
646 20101114:
647         Generic IEEE 802.3 annex 31B full duplex flow control support has been
648         added to mii(4) and bge(4), bce(4), msk(4), nfe(4) and stge(4) along
649         with brgphy(4), e1000phy(4) as well as ip1000phy() have been converted
650         to take advantage of it instead of using custom implementations.  This
651         means that these drivers now no longer unconditionally advertise
652         support for flow control but only do so if flow control is a selected
653         media option.  This was implemented in the generic support that way in
654         order to allow flow control to be switched on and off via ifconfig(8)
655         with the PHY specific default to typically off in order to protect
656         from unwanted effects.  Consequently, if you used flow control with
657         one of the above mentioned drivers you now need to explicitly enable
658         it, for example via:
659                 ifconfig bge0 media auto mediaopt flowcontrol
660
661         Along with the above mentioned changes generic support for setting
662         1000baseT master mode also has been added and brgphy(4), ciphy(4),
663         e1000phy(4) as well as ip1000phy(4) have been converted to take
664         advantage of it.  This means that these drivers now no longer take the
665         link0 parameter for selecting master mode but the master media option
666         has to be used instead, for example like in the following:
667                 ifconfig bge0 media 1000baseT mediaopt full-duplex,master
668
669         Selection of master mode now is also available with all other PHY
670         drivers supporting 1000baseT.
671
672 20101111:
673         The TCP stack has received a significant update to add support for
674         modularised congestion control and generally improve the clarity of
675         congestion control decisions. Bump __FreeBSD_version to 900025. User
676         space tools that rely on the size of struct tcpcb in tcp_var.h (e.g.
677         sockstat) need to be recompiled.
678
679 20101002:
680         The man(1) utility has been replaced by a new version that no longer
681         uses /etc/manpath.config. Please consult man.conf(5) for how to
682         migrate local entries to the new format.
683
684 20100928:
685         The copyright strings printed by login(1) and sshd(8) at the time of a
686         new connection have been removed to follow other operating systems and
687         upstream sshd.
688
689 20100915:
690         A workaround for a fixed ld bug has been removed in kernel code,
691         so make sure that your system ld is built from sources after
692         revision 210245 from 2010-07-19 (r211583 if building head kernel
693         on stable/8, r211584 for stable/7; both from 2010-08-21).
694         A symptom of incorrect ld version is different addresses for
695         set_pcpu section and __start_set_pcpu symbol in kernel and/or modules.
696
697 20100913:
698         The $ipv6_prefer variable in rc.conf(5) has been split into
699         $ip6addrctl_policy and $ipv6_activate_all_interfaces.
700
701         The $ip6addrctl_policy is a variable to choose a pre-defined
702         address selection policy set by ip6addrctl(8).  A value
703         "ipv4_prefer", "ipv6_prefer" or "AUTO" can be specified.  The
704         default is "AUTO".
705
706         The $ipv6_activate_all_interfaces specifies whether IFDISABLED
707         flag (see an entry of 20090926) is set on an interface with no
708         corresponding $ifconfig_IF_ipv6 line.  The default is "NO" for
709         security reason.  If you want IPv6 link-local address on all
710         interfaces by default, set this to "YES".
711
712         The old ipv6_prefer="YES" is equivalent to
713         ipv6_activate_all_interfaces="YES" and
714         ip6addrctl_policy="ipv6_prefer".
715
716 20100913:
717         DTrace has grown support for userland tracing. Due to this, DTrace is
718         now i386 and amd64 only.
719         dtruss(1) is now installed by default on those systems and a new
720         kernel module is needed for userland tracing: fasttrap.
721         No changes to your kernel config file are necessary to enable
722         userland tracing, but you might consider adding 'STRIP=' and
723         'CFLAGS+=-fno-omit-frame-pointer' to your make.conf if you want
724         to have informative userland stack traces in DTrace (ustack).
725
726 20100725:
727         The acpi_aiboost(4) driver has been removed in favor of the new
728         aibs(4) driver. You should update your kernel configuration file.
729
730 20100722:
731         BSD grep has been imported to the base system and it is built by
732         default.  It is completely BSD licensed, highly GNU-compatible, uses
733         less memory than its GNU counterpart and has a small codebase.
734         However, it is slower than its GNU counterpart, which is mostly
735         noticeable for larger searches, for smaller ones it is measurable
736         but not significant.  The reason is complex, the most important factor
737         is that we lack a modern and efficient regex library and GNU
738         overcomes this by optimizing the searches internally.  Future work
739         on improving the regex performance is planned, for the meantime,
740         users that need better performance, can build GNU grep instead by
741         setting the WITH_GNU_GREP knob.
742
743 20100713:
744         Due to the import of powerpc64 support, all existing powerpc kernel
745         configuration files must be updated with a machine directive like this:
746             machine powerpc powerpc
747
748         In addition, an updated config(8) is required to build powerpc kernels
749         after this change.
750
751 20100713:
752         A new version of ZFS (version 15) has been merged to -HEAD.
753         This version uses a python library for the following subcommands:
754         zfs allow, zfs unallow, zfs groupspace, zfs userspace.
755         For full functionality of these commands the following port must
756         be installed: sysutils/py-zfs
757
758 20100429:
759         'vm_page's are now hashed by physical address to an array of mutexes.
760         Currently this is only used to serialize access to hold_count. Over 
761         time the page queue mutex will be peeled away. This changes the size
762         of pmap on every architecture. And requires all callers of vm_page_hold
763         and vm_page_unhold to be updated. 
764  
765 20100402:
766         WITH_CTF can now be specified in src.conf (not recommended, there
767         are some problems with static executables), make.conf (would also
768         affect ports which do not use GNU make and do not override the
769         compile targets) or in the kernel config (via "makeoptions
770         WITH_CTF=yes").
771         When WITH_CTF was specified there before this was silently ignored,
772         so make sure that WITH_CTF is not used in places which could lead
773         to unwanted behavior.
774
775 20100311:
776         The kernel option COMPAT_IA32 has been replaced with COMPAT_FREEBSD32
777         to allow 32-bit compatibility on non-x86 platforms. All kernel
778         configurations on amd64 and ia64 platforms using these options must
779         be modified accordingly.
780
781 20100113:
782         The utmp user accounting database has been replaced with utmpx,
783         the user accounting interface standardized by POSIX.
784         Unfortunately the semantics of utmp and utmpx don't match,
785         making it practically impossible to support both interfaces.
786         The user accounting database is used by tools like finger(1),
787         last(1), talk(1), w(1) and ac(8).
788
789         All applications in the base system use utmpx.  This means only
790         local binaries (e.g. from the ports tree) may still use these
791         utmp database files.  These applications must be rebuilt to make
792         use of utmpx.
793
794         After the system has been upgraded, it is safe to remove the old
795         log files (/var/run/utmp, /var/log/lastlog and /var/log/wtmp*),
796         assuming their contents is of no importance anymore.  Old wtmp
797         databases can only be used by last(1) and ac(8) after they have
798         been converted to the new format using wtmpcvt(1).
799
800 20100108:
801         Introduce the kernel thread "deadlock resolver" (which can be enabled
802         via the DEADLKRES option, see NOTES for more details) and the
803         sleepq_type() function for sleepqueues.
804
805 20091202:
806         The rc.firewall and rc.firewall6 were unified, and
807         rc.firewall6 and rc.d/ip6fw were removed.
808         According to the removal of rc.d/ip6fw, ipv6_firewall_* rc
809         variables are obsoleted.  Instead, the following new rc
810         variables are added to rc.d/ipfw:
811
812                 firewall_client_net_ipv6, firewall_simple_iif_ipv6,
813                 firewall_simple_inet_ipv6, firewall_simple_oif_ipv6,
814                 firewall_simple_onet_ipv6, firewall_trusted_ipv6
815
816         The meanings correspond to the relevant IPv4 variables.
817
818 20091125:
819         8.0-RELEASE.
820
821 20091113:
822         The default terminal emulation for syscons(4) has been changed
823         from cons25 to xterm on all platforms except pc98.  This means
824         that the /etc/ttys file needs to be updated to ensure correct
825         operation of applications on the console.
826
827         The terminal emulation style can be toggled per window by using
828         vidcontrol(1)'s -T flag.  The TEKEN_CONS25 kernel configuration
829         options can be used to change the compile-time default back to
830         cons25.
831
832         To prevent graphical artifacts, make sure the TERM environment
833         variable is set to match the terminal emulation that is being
834         performed by syscons(4).
835
836 20091109:
837         The layout of the structure ieee80211req_scan_result has changed.
838         Applications that require wireless scan results (e.g. ifconfig(8))
839         from net80211 need to be recompiled.
840
841         Applications such as wpa_supplicant(8) may require a full world
842         build without using NO_CLEAN in order to get synchronized with the
843         new structure.
844
845 20091025:
846         The iwn(4) driver has been updated to support the 5000 and 5150 series.
847         There's one kernel module for each firmware. Adding "device iwnfw"
848         to the kernel configuration file means including all three firmware
849         images inside the kernel. If you want to include just the one for
850         your wireless card, use the devices iwn4965fw, iwn5000fw or
851         iwn5150fw.
852
853 20090926:
854         The rc.d/network_ipv6, IPv6 configuration script has been integrated
855         into rc.d/netif.  The changes are the following:
856
857         1. To use IPv6, simply define $ifconfig_IF_ipv6 like $ifconfig_IF
858            for IPv4.  For aliases, $ifconfig_IF_aliasN should be used.
859            Note that both variables need the "inet6" keyword at the head.
860
861            Do not set $ipv6_network_interfaces manually if you do not
862            understand what you are doing.  It is not needed in most cases. 
863
864            $ipv6_ifconfig_IF and $ipv6_ifconfig_IF_aliasN still work, but
865            they are obsolete.
866
867         2. $ipv6_enable is obsolete.  Use $ipv6_prefer and
868            "inet6 accept_rtadv" keyword in ifconfig(8) instead.
869
870            If you define $ipv6_enable=YES, it means $ipv6_prefer=YES and
871            all configured interfaces have "inet6 accept_rtadv" in the
872            $ifconfig_IF_ipv6.  These are for backward compatibility.
873
874         3. A new variable $ipv6_prefer has been added.  If NO, IPv6
875            functionality of interfaces with no corresponding
876            $ifconfig_IF_ipv6 is disabled by using "inet6 ifdisabled" flag,
877            and the default address selection policy of ip6addrctl(8) 
878            is the IPv4-preferred one (see rc.d/ip6addrctl for more details).
879            Note that if you want to configure IPv6 functionality on the
880            disabled interfaces after boot, first you need to clear the flag by
881            using ifconfig(8) like:
882
883                 ifconfig em0 inet6 -ifdisabled
884
885            If YES, the default address selection policy is set as
886            IPv6-preferred.
887
888            The default value of $ipv6_prefer is NO.
889
890         4. If your system need to receive Router Advertisement messages,
891            define "inet6 accept_rtadv" in $ifconfig_IF_ipv6.  The rc(8)
892            scripts automatically invoke rtsol(8) when the interface becomes
893            UP.  The Router Advertisement messages are used for SLAAC
894            (State-Less Address AutoConfiguration).
895
896 20090922:
897         802.11s D3.03 support was committed. This is incompatible with the
898         previous code, which was based on D3.0.
899
900 20090912:
901         A sysctl variable net.inet6.ip6.accept_rtadv now sets the default value
902         of a per-interface flag ND6_IFF_ACCEPT_RTADV, not a global knob to
903         control whether accepting Router Advertisement messages or not.
904         Also, a per-interface flag ND6_IFF_AUTO_LINKLOCAL has been added and
905         a sysctl variable net.inet6.ip6.auto_linklocal is its default value.
906         The ifconfig(8) utility now supports these flags.
907
908 20090910:
909         ZFS snapshots are now mounted with MNT_IGNORE flag. Use -v option for
910         mount(8) and -a option for df(1) to see them.
911
912 20090825:
913         The old tunable hw.bus.devctl_disable has been superseded by
914         hw.bus.devctl_queue.  hw.bus.devctl_disable=1 in loader.conf should be
915         replaced by hw.bus.devctl_queue=0.  The default for this new tunable
916         is 1000.
917
918 20090813:
919         Remove the option STOP_NMI.  The default action is now to use NMI only
920         for KDB via the newly introduced function stop_cpus_hard() and
921         maintain stop_cpus() to just use a normal IPI_STOP on ia32 and amd64.
922
923 20090803:
924         The stable/8 branch created in subversion.  This corresponds to the
925         RELENG_8 branch in CVS.
926
927 20090719:
928         Bump the shared library version numbers for all libraries that do not
929         use symbol versioning as part of the 8.0-RELEASE cycle.  Bump
930         __FreeBSD_version to 800105.
931
932 20090714:
933         Due to changes in the implementation of virtual network stack support,
934         all network-related kernel modules must be recompiled.  As this change
935         breaks the ABI, bump __FreeBSD_version to 800104.
936
937 20090713:
938         The TOE interface to the TCP syncache has been modified to remove
939         struct tcpopt (<netinet/tcp_var.h>) from the ABI of the network stack.
940         The cxgb driver is the only TOE consumer affected by this change, and
941         needs to be recompiled along with the kernel. As this change breaks
942         the ABI, bump __FreeBSD_version to 800103.
943
944 20090712: 
945         Padding has been added to struct tcpcb, sackhint and tcpstat in
946         <netinet/tcp_var.h> to facilitate future MFCs and bug fixes whilst
947         maintaining the ABI. However, this change breaks the ABI, so bump
948         __FreeBSD_version to 800102. User space tools that rely on the size of
949         any of these structs (e.g. sockstat) need to be recompiled.
950
951 20090630:
952         The NFS_LEGACYRPC option has been removed along with the old kernel
953         RPC implementation that this option selected. Kernel configurations
954         may need to be adjusted.
955
956 20090629:
957         The network interface device nodes at /dev/net/<interface> have been
958         removed.  All ioctl operations can be performed the normal way using
959         routing sockets.  The kqueue functionality can generally be replaced
960         with routing sockets.
961
962 20090628:
963         The documentation from the FreeBSD Documentation Project (Handbook,
964         FAQ, etc.) is now installed via packages by sysinstall(8) and under
965         the /usr/local/share/doc/freebsd directory instead of /usr/share/doc.
966
967 20090624:
968         The ABI of various structures related to the SYSV IPC API have been
969         changed.  As a result, the COMPAT_FREEBSD[456] and COMPAT_43 kernel
970         options now all require COMPAT_FREEBSD7.  Bump __FreeBSD_version to
971         800100.
972
973 20090622:
974         Layout of struct vnet has changed as routing related variables were
975         moved to their own Vimage module. Modules need to be recompiled.  Bump
976         __FreeBSD_version to 800099.
977
978 20090619:
979         NGROUPS_MAX and NGROUPS have been increased from 16 to 1023 and 1024
980         respectively.  As long as no more than 16 groups per process are used,
981         no changes should be visible.  When more than 16 groups are used, old
982         binaries may fail if they call getgroups() or getgrouplist() with
983         statically sized storage.  Recompiling will work around this, but
984         applications should be modified to use dynamically allocated storage
985         for group arrays as POSIX.1-2008 does not cap an implementation's
986         number of supported groups at NGROUPS_MAX+1 as previous versions did.
987
988         NFS and portalfs mounts may also be affected as the list of groups is
989         truncated to 16.  Users of NFS who use more than 16 groups, should
990         take care that negative group permissions are not used on the exported
991         file systems as they will not be reliable unless a GSSAPI based
992         authentication method is used.
993
994 20090616: 
995         The compiling option ADAPTIVE_LOCKMGRS has been introduced.  This
996         option compiles in the support for adaptive spinning for lockmgrs
997         which want to enable it.  The lockinit() function now accepts the flag
998         LK_ADAPTIVE in order to make the lock object subject to adaptive
999         spinning when both held in write and read mode.
1000
1001 20090613:
1002         The layout of the structure returned by IEEE80211_IOC_STA_INFO has
1003         changed.  User applications that use this ioctl need to be rebuilt.
1004
1005 20090611:
1006         The layout of struct thread has changed.  Kernel and modules need to
1007         be rebuilt.
1008
1009 20090608:
1010         The layout of structs ifnet, domain, protosw and vnet_net has changed.
1011         Kernel modules need to be rebuilt.  Bump __FreeBSD_version to 800097.
1012
1013 20090602:
1014         window(1) has been removed from the base system. It can now be
1015         installed from ports. The port is called misc/window.
1016
1017 20090601:
1018         The way we are storing and accessing `routing table' entries has
1019         changed. Programs reading the FIB, like netstat, need to be
1020         re-compiled.
1021
1022 20090601:
1023         A new netisr implementation has been added for FreeBSD 8.  Network
1024         file system modules, such as igmp, ipdivert, and others, should be
1025         rebuilt.
1026         Bump __FreeBSD_version to 800096.
1027
1028 20090530:
1029         Remove the tunable/sysctl debug.mpsafevfs as its initial purpose is no
1030         more valid.
1031
1032 20090530:
1033         Add VOP_ACCESSX(9).  File system modules need to be rebuilt.
1034         Bump __FreeBSD_version to 800094.
1035
1036 20090529:
1037         Add mnt_xflag field to 'struct mount'.  File system modules need to be
1038         rebuilt.
1039         Bump __FreeBSD_version to 800093.
1040
1041 20090528:
1042         The compiling option ADAPTIVE_SX has been retired while it has been
1043         introduced the option NO_ADAPTIVE_SX which handles the reversed logic.
1044         The KPI for sx_init_flags() changes as accepting flags:
1045         SX_ADAPTIVESPIN flag has been retired while the SX_NOADAPTIVE flag has
1046         been introduced in order to handle the reversed logic.
1047         Bump __FreeBSD_version to 800092.
1048
1049 20090527:
1050         Add support for hierarchical jails.  Remove global securelevel.
1051         Bump __FreeBSD_version to 800091.
1052
1053 20090523:
1054         The layout of struct vnet_net has changed, therefore modules
1055         need to be rebuilt.
1056         Bump __FreeBSD_version to 800090.
1057
1058 20090523:
1059         The newly imported zic(8) produces a new format in the output. Please
1060         run tzsetup(8) to install the newly created data to /etc/localtime.
1061
1062 20090520:
1063         The sysctl tree for the usb stack has renamed from hw.usb2.* to
1064         hw.usb.* and is now consistent again with previous releases.
1065
1066 20090520:
1067         802.11 monitor mode support was revised and driver api's were changed.
1068         Drivers dependent on net80211 now support DLT_IEEE802_11_RADIO instead
1069         of DLT_IEEE802_11.  No user-visible data structures were changed but
1070         applications that use DLT_IEEE802_11 may require changes.
1071         Bump __FreeBSD_version to 800088.
1072
1073 20090430:
1074         The layout of the following structs has changed: sysctl_oid,
1075         socket, ifnet, inpcbinfo, tcpcb, syncache_head, vnet_inet,
1076         vnet_inet6 and vnet_ipfw.  Most modules need to be rebuild or
1077         panics may be experienced.  World rebuild is required for
1078         correctly checking networking state from userland.
1079         Bump __FreeBSD_version to 800085.
1080
1081 20090429:
1082         MLDv2 and Source-Specific Multicast (SSM) have been merged
1083         to the IPv6 stack. VIMAGE hooks are in but not yet used.
1084         The implementation of SSM within FreeBSD's IPv6 stack closely
1085         follows the IPv4 implementation.
1086
1087         For kernel developers:
1088
1089         * The most important changes are that the ip6_output() and
1090           ip6_input() paths no longer take the IN6_MULTI_LOCK,
1091           and this lock has been downgraded to a non-recursive mutex.
1092
1093         * As with the changes to the IPv4 stack to support SSM, filtering
1094           of inbound multicast traffic must now be performed by transport
1095           protocols within the IPv6 stack. This does not apply to TCP and
1096           SCTP, however, it does apply to UDP in IPv6 and raw IPv6.
1097
1098         * The KPIs used by IPv6 multicast are similar to those used by
1099           the IPv4 stack, with the following differences:
1100            * im6o_mc_filter() is analogous to imo_multicast_filter().
1101            * The legacy KAME entry points in6_joingroup and in6_leavegroup()
1102              are shimmed to in6_mc_join() and in6_mc_leave() respectively.
1103            * IN6_LOOKUP_MULTI() has been deprecated and removed.
1104            * IPv6 relies on MLD for the DAD mechanism. KAME's internal KPIs
1105              for MLDv1 have an additional 'timer' argument which is used to
1106              jitter the initial membership report for the solicited-node
1107              multicast membership on-link.
1108            * This is not strictly needed for MLDv2, which already jitters
1109              its report transmissions.  However, the 'timer' argument is
1110              preserved in case MLDv1 is active on the interface.
1111
1112         * The KAME linked-list based IPv6 membership implementation has
1113           been refactored to use a vector similar to that used by the IPv4
1114           stack.
1115           Code which maintains a list of its own multicast memberships
1116           internally, e.g. carp, has been updated to reflect the new
1117           semantics.
1118
1119         * There is a known Lock Order Reversal (LOR) due to in6_setscope()
1120           acquiring the IF_AFDATA_LOCK and being called within ip6_output().
1121           Whilst MLDv2 tries to avoid this otherwise benign LOR, it is an
1122           implementation constraint which needs to be addressed in HEAD.
1123
1124         For application developers:
1125
1126         * The changes are broadly similar to those made for the IPv4
1127           stack.
1128
1129         * The use of IPv4 and IPv6 multicast socket options on the same
1130           socket, using mapped addresses, HAS NOT been tested or supported.
1131
1132         * There are a number of issues with the implementation of various
1133           IPv6 multicast APIs which need to be resolved in the API surface
1134           before the implementation is fully compatible with KAME userland
1135           use, and these are mostly to do with interface index treatment.
1136
1137         * The literature available discusses the use of either the delta / ASM
1138           API with setsockopt(2)/getsockopt(2), or the full-state / ASM API
1139           using setsourcefilter(3)/getsourcefilter(3). For more information
1140           please refer to RFC 3768, 'Socket Interface Extensions for
1141           Multicast Source Filters'.
1142
1143         * Applications which use the published RFC 3678 APIs should be fine.
1144
1145         For systems administrators:
1146
1147         * The mtest(8) utility has been refactored to support IPv6, in
1148           addition to IPv4. Interface addresses are no longer accepted
1149           as arguments, their names must be used instead. The utility
1150           will map the interface name to its first IPv4 address as
1151           returned by getifaddrs(3).
1152
1153         * The ifmcstat(8) utility has also been updated to print the MLDv2
1154           endpoint state and source filter lists via sysctl(3).
1155
1156         * The net.inet6.ip6.mcast.loop sysctl may be tuned to 0 to disable
1157           loopback of IPv6 multicast datagrams by default; it defaults to 1
1158           to preserve the existing behaviour. Disabling multicast loopback is
1159           recommended for optimal system performance.
1160
1161         * The IPv6 MROUTING code has been changed to examine this sysctl
1162           instead of attempting to perform a group lookup before looping
1163           back forwarded datagrams.
1164
1165         Bump __FreeBSD_version to 800084.
1166
1167 20090422:
1168         Implement low-level Bluetooth HCI API.
1169         Bump __FreeBSD_version to 800083.
1170
1171 20090419:
1172         The layout of struct malloc_type, used by modules to register new
1173         memory allocation types, has changed.  Most modules will need to
1174         be rebuilt or panics may be experienced.
1175         Bump __FreeBSD_version to 800081.
1176
1177 20090415:
1178         Anticipate overflowing inp_flags - add inp_flags2.
1179         This changes most offsets in inpcb, so checking v4 connection
1180         state will require a world rebuild.
1181         Bump __FreeBSD_version to 800080.
1182
1183 20090415:
1184         Add an llentry to struct route and struct route_in6. Modules
1185         embedding a struct route will need to be recompiled.
1186         Bump __FreeBSD_version to 800079.
1187
1188 20090414:
1189         The size of rt_metrics_lite and by extension rtentry has changed.
1190         Networking administration apps will need to be recompiled.
1191         The route command now supports show as an alias for get, weighting
1192         of routes, sticky and nostick flags to alter the behavior of stateful
1193         load balancing.
1194         Bump __FreeBSD_version to 800078.
1195
1196 20090408:
1197         Do not use Giant for kbdmux(4) locking. This is wrong and
1198         apparently causing more problems than it solves. This will
1199         re-open the issue where interrupt handlers may race with
1200         kbdmux(4) in polling mode. Typical symptoms include (but
1201         not limited to) duplicated and/or missing characters when
1202         low level console functions (such as gets) are used while
1203         interrupts are enabled (for example geli password prompt,
1204         mountroot prompt etc.). Disabling kbdmux(4) may help.
1205
1206 20090407:
1207         The size of structs vnet_net, vnet_inet and vnet_ipfw has changed;
1208         kernel modules referencing any of the above need to be recompiled.
1209         Bump __FreeBSD_version to 800075.
1210
1211 20090320:
1212         GEOM_PART has become the default partition slicer for storage devices,
1213         replacing GEOM_MBR, GEOM_BSD, GEOM_PC98 and GEOM_GPT slicers. It
1214         introduces some changes:
1215
1216         MSDOS/EBR: the devices created from MSDOS extended partition entries
1217         (EBR) can be named differently than with GEOM_MBR and are now symlinks
1218         to devices with offset-based names. fstabs may need to be modified.
1219
1220         BSD: the "geometry does not match label" warning is harmless in most
1221         cases but it points to problems in file system misalignment with
1222         disk geometry. The "c" partition is now implicit, covers the whole
1223         top-level drive and cannot be (mis)used by users.
1224
1225         General: Kernel dumps are now not allowed to be written to devices
1226         whose partition types indicate they are meant to be used for file
1227         systems (or, in case of MSDOS partitions, as something else than
1228         the "386BSD" type).
1229
1230         Most of these changes date approximately from 200812.
1231
1232 20090319:
1233         The uscanner(4) driver has been removed from the kernel. This follows
1234         Linux removing theirs in 2.6 and making libusb the default interface
1235         (supported by sane).
1236
1237 20090319:
1238         The multicast forwarding code has been cleaned up. netstat(1)
1239         only relies on KVM now for printing bandwidth upcall meters.
1240         The IPv4 and IPv6 modules are split into ip_mroute_mod and
1241         ip6_mroute_mod respectively. The config(5) options for statically
1242         compiling this code remain the same, i.e. 'options MROUTING'.
1243
1244 20090315:
1245         Support for the IFF_NEEDSGIANT network interface flag has been
1246         removed, which means that non-MPSAFE network device drivers are no
1247         longer supported.  In particular, if_ar, if_sr, and network device
1248         drivers from the old (legacy) USB stack can no longer be built or
1249         used.
1250
1251 20090313:
1252         POSIX.1 Native Language Support (NLS) has been enabled in libc and
1253         a bunch of new language catalog files have also been added.
1254         This means that some common libc messages are now localized and
1255         they depend on the LC_MESSAGES environmental variable.
1256
1257 20090313:
1258         The k8temp(4) driver has been renamed to amdtemp(4) since
1259         support for Family 10 and Family 11 CPU families was added.
1260
1261 20090309:
1262         IGMPv3 and Source-Specific Multicast (SSM) have been merged
1263         to the IPv4 stack. VIMAGE hooks are in but not yet used.
1264
1265         For kernel developers, the most important changes are that the
1266         ip_output() and ip_input() paths no longer take the IN_MULTI_LOCK(),
1267         and this lock has been downgraded to a non-recursive mutex.
1268
1269         Transport protocols (UDP, Raw IP) are now responsible for filtering
1270         inbound multicast traffic according to group membership and source
1271         filters. The imo_multicast_filter() KPI exists for this purpose.
1272         Transports which do not use multicast (SCTP, TCP) already reject
1273         multicast by default. Forwarding and receive performance may improve
1274         as a mutex acquisition is no longer needed in the ip_input()
1275         low-level input path.  in_addmulti() and in_delmulti() are shimmed
1276         to new KPIs which exist to support SSM in-kernel.
1277
1278         For application developers, it is recommended that loopback of
1279         multicast datagrams be disabled for best performance, as this
1280         will still cause the lock to be taken for each looped-back
1281         datagram transmission. The net.inet.ip.mcast.loop sysctl may
1282         be tuned to 0 to disable loopback by default; it defaults to 1
1283         to preserve the existing behaviour.
1284
1285         For systems administrators, to obtain best performance with
1286         multicast reception and multiple groups, it is always recommended
1287         that a card with a suitably precise hash filter is used. Hash
1288         collisions will still result in the lock being taken within the
1289         transport protocol input path to check group membership.
1290
1291         If deploying FreeBSD in an environment with IGMP snooping switches,
1292         it is recommended that the net.inet.igmp.sendlocal sysctl remain
1293         enabled; this forces 224.0.0.0/24 group membership to be announced
1294         via IGMP.
1295
1296         The size of 'struct igmpstat' has changed; netstat needs to be
1297         recompiled to reflect this.
1298         Bump __FreeBSD_version to 800070.
1299
1300 20090309:
1301         libusb20.so.1 is now installed as libusb.so.1 and the ports system
1302         updated to use it. This requires a buildworld/installworld in order to
1303         update the library and dependencies (usbconfig, etc). Its advisable to
1304         rebuild all ports which uses libusb. More specific directions are given
1305         in the ports collection UPDATING file. Any /etc/libmap.conf entries for
1306         libusb are no longer required and can be removed.
1307
1308 20090302:
1309         A workaround is committed to allow the creation of System V shared
1310         memory segment of size > 2 GB on the 64-bit architectures.
1311         Due to a limitation of the existing ABI, the shm_segsz member
1312         of the struct shmid_ds, returned by shmctl(IPC_STAT) call is
1313         wrong for large segments. Note that limits must be explicitly
1314         raised to allow such segments to be created.
1315
1316 20090301:
1317         The layout of struct ifnet has changed, requiring a rebuild of all
1318         network device driver modules.
1319
1320 20090227:
1321         The /dev handling for the new USB stack has changed, a
1322         buildworld/installworld is required for libusb20.
1323
1324 20090223:
1325         The new USB2 stack has now been permanently moved in and all kernel and
1326         module names reverted to their previous values (eg, usb, ehci, ohci,
1327         ums, ...).  The old usb stack can be compiled in by prefixing the name
1328         with the letter 'o', the old usb modules have been removed.
1329         Updating entry 20090216 for xorg and 20090215 for libmap may still
1330         apply.
1331
1332 20090217:
1333         The rc.conf(5) option if_up_delay has been renamed to
1334         defaultroute_delay to better reflect its purpose. If you have
1335         customized this setting in /etc/rc.conf you need to update it to
1336         use the new name.
1337
1338 20090216:
1339         xorg 7.4 wants to configure its input devices via hald which does not
1340         yet work with USB2. If the keyboard/mouse does not work in xorg then
1341         add
1342                 Option "AllowEmptyInput" "off"
1343         to your ServerLayout section.  This will cause X to use the configured
1344         kbd and mouse sections from your xorg.conf.
1345
1346 20090215:
1347         The GENERIC kernels for all architectures now default to the new USB2
1348         stack. No kernel config options or code have been removed so if a
1349         problem arises please report it and optionally revert to the old USB
1350         stack. If you are loading USB kernel modules or have a custom kernel
1351         that includes GENERIC then ensure that usb names are also changed over,
1352         eg uftdi -> usb2_serial_ftdi.
1353
1354         Older programs linked against the ports libusb 0.1 need to be
1355         redirected to the new stack's libusb20.  /etc/libmap.conf can
1356         be used for this:
1357                 # Map old usb library to new one for usb2 stack
1358                 libusb-0.1.so.8 libusb20.so.1
1359
1360 20090209:
1361         All USB ethernet devices now attach as interfaces under the name ueN
1362         (eg. ue0). This is to provide a predictable name as vendors often
1363         change usb chipsets in a product without notice.
1364
1365 20090203:
1366         The ichsmb(4) driver has been changed to require SMBus slave
1367         addresses be left-justified (xxxxxxx0b) rather than right-justified.
1368         All of the other SMBus controller drivers require left-justified
1369         slave addresses, so this change makes all the drivers provide the
1370         same interface.
1371
1372 20090201:
1373         INET6 statistics (struct ip6stat) was updated.
1374         netstat(1) needs to be recompiled.
1375
1376 20090119:
1377         NTFS has been removed from GENERIC kernel on amd64 to match
1378         GENERIC on i386. Should not cause any issues since mount_ntfs(8)
1379         will load ntfs.ko module automatically when NTFS support is
1380         actually needed, unless ntfs.ko is not installed or security
1381         level prohibits loading kernel modules. If either is the case,
1382         "options NTFS" has to be added into kernel config.
1383
1384 20090115:
1385         TCP Appropriate Byte Counting (RFC 3465) support added to kernel.
1386         New field in struct tcpcb breaks ABI, so bump __FreeBSD_version to
1387         800061. User space tools that rely on the size of struct tcpcb in
1388         tcp_var.h (e.g. sockstat) need to be recompiled.
1389
1390 20081225:
1391         ng_tty(4) module updated to match the new TTY subsystem.
1392         Due to API change, user-level applications must be updated.
1393         New API support added to mpd5 CVS and expected to be present
1394         in next mpd5.3 release.
1395
1396 20081219:
1397         With __FreeBSD_version 800060 the makefs tool is part of
1398         the base system (it was a port).
1399
1400 20081216:
1401         The afdata and ifnet locks have been changed from mutexes to
1402         rwlocks, network modules will need to be re-compiled.
1403
1404 20081214:
1405         __FreeBSD_version 800059 incorporates the new arp-v2 rewrite.
1406         RTF_CLONING, RTF_LLINFO and RTF_WASCLONED flags are eliminated.
1407         The new code reduced struct rtentry{} by 16 bytes on 32-bit
1408         architecture and 40 bytes on 64-bit architecture. The userland
1409         applications "arp" and "ndp" have been updated accordingly.
1410         The output from "netstat -r" shows only routing entries and
1411         none of the L2 information.
1412
1413 20081130:
1414         __FreeBSD_version 800057 marks the switchover from the
1415         binary ath hal to source code. Users must add the line:
1416
1417         options AH_SUPPORT_AR5416
1418
1419         to their kernel config files when specifying:
1420
1421         device  ath_hal
1422
1423         The ath_hal module no longer exists; the code is now compiled
1424         together with the driver in the ath module.  It is now
1425         possible to tailor chip support (i.e. reduce the set of chips
1426         and thereby the code size); consult ath_hal(4) for details.
1427
1428 20081121:
1429         __FreeBSD_version 800054 adds memory barriers to
1430         <machine/atomic.h>, new interfaces to ifnet to facilitate
1431         multiple hardware transmit queues for cards that support
1432         them, and a lock-less ring-buffer implementation to
1433         enable drivers to more efficiently manage queueing of
1434         packets.
1435
1436 20081117:
1437         A new version of ZFS (version 13) has been merged to -HEAD.
1438         This version has zpool attribute "listsnapshots" off by
1439         default, which means "zfs list" does not show snapshots,
1440         and is the same as Solaris behavior.
1441
1442 20081028:
1443         dummynet(4) ABI has changed. ipfw(8) needs to be recompiled.
1444
1445 20081009:
1446         The uhci, ohci, ehci and slhci USB Host controller drivers have
1447         been put into separate modules. If you load the usb module
1448         separately through loader.conf you will need to load the
1449         appropriate *hci module as well. E.g. for a UHCI-based USB 2.0
1450         controller add the following to loader.conf:
1451
1452                 uhci_load="YES"
1453                 ehci_load="YES"
1454
1455 20081009:
1456         The ABI used by the PMC toolset has changed.  Please keep
1457         userland (libpmc(3)) and the kernel module (hwpmc(4)) in
1458         sync.
1459
1460 20081009:
1461         atapci kernel module now includes only generic PCI ATA
1462         driver. AHCI driver moved to ataahci kernel module.
1463         All vendor-specific code moved into separate kernel modules:
1464         ataacard, ataacerlabs, ataadaptec, ataamd, ataati, atacenatek,
1465         atacypress, atacyrix, atahighpoint, ataintel, ataite, atajmicron,
1466         atamarvell, atamicron, atanational, atanetcell, atanvidia,
1467         atapromise, ataserverworks, atasiliconimage, atasis, atavia
1468
1469 20080820:
1470         The TTY subsystem of the kernel has been replaced by a new
1471         implementation, which provides better scalability and an
1472         improved driver model. Most common drivers have been migrated to
1473         the new TTY subsystem, while others have not. The following
1474         drivers have not yet been ported to the new TTY layer:
1475
1476         PCI/ISA:
1477                 cy, digi, rc, rp, sio
1478
1479         USB:
1480                 ubser, ucycom
1481
1482         Line disciplines:
1483                 ng_h4, ng_tty, ppp, sl, snp
1484
1485         Adding these drivers to your kernel configuration file shall
1486         cause compilation to fail.
1487
1488 20080818:
1489         ntpd has been upgraded to 4.2.4p5.
1490
1491 20080801:
1492         OpenSSH has been upgraded to 5.1p1.
1493
1494         For many years, FreeBSD's version of OpenSSH preferred DSA
1495         over RSA for host and user authentication keys.  With this
1496         upgrade, we've switched to the vendor's default of RSA over
1497         DSA.  This may cause upgraded clients to warn about unknown
1498         host keys even for previously known hosts.  Users should
1499         follow the usual procedure for verifying host keys before
1500         accepting the RSA key.
1501
1502         This can be circumvented by setting the "HostKeyAlgorithms"
1503         option to "ssh-dss,ssh-rsa" in ~/.ssh/config or on the ssh
1504         command line.
1505
1506         Please note that the sequence of keys offered for
1507         authentication has been changed as well.  You may want to
1508         specify IdentityFile in a different order to revert this
1509         behavior.
1510
1511 20080713:
1512         The sio(4) driver has been removed from the i386 and amd64
1513         kernel configuration files. This means uart(4) is now the
1514         default serial port driver on those platforms as well.
1515
1516         To prevent collisions with the sio(4) driver, the uart(4) driver
1517         uses different names for its device nodes. This means the
1518         onboard serial port will now most likely be called "ttyu0"
1519         instead of "ttyd0". You may need to reconfigure applications to
1520         use the new device names.
1521
1522         When using the serial port as a boot console, be sure to update
1523         /boot/device.hints and /etc/ttys before booting the new kernel.
1524         If you forget to do so, you can still manually specify the hints
1525         at the loader prompt:
1526
1527                 set hint.uart.0.at="isa"
1528                 set hint.uart.0.port="0x3F8"
1529                 set hint.uart.0.flags="0x10"
1530                 set hint.uart.0.irq="4"
1531                 boot -s
1532
1533 20080609:
1534         The gpt(8) utility has been removed. Use gpart(8) to partition
1535         disks instead.
1536
1537 20080603:
1538         The version that Linuxulator emulates was changed from 2.4.2
1539         to 2.6.16. If you experience any problems with Linux binaries
1540         please try to set sysctl compat.linux.osrelease to 2.4.2 and
1541         if it fixes the problem contact emulation mailing list.
1542
1543 20080525:
1544         ISDN4BSD (I4B) was removed from the src tree. You may need to
1545         update a your kernel configuration and remove relevant entries.
1546
1547 20080509:
1548         I have checked in code to support multiple routing tables.
1549         See the man pages setfib(1) and setfib(2).
1550         This is a hopefully backwards compatible version,
1551         but to make use of it you need to compile your kernel
1552         with options ROUTETABLES=2 (or more up to 16).
1553
1554 20080420:
1555         The 802.11 wireless support was redone to enable multi-bss
1556         operation on devices that are capable.  The underlying device
1557         is no longer used directly but instead wlanX devices are
1558         cloned with ifconfig.  This requires changes to rc.conf files.
1559         For example, change:
1560                 ifconfig_ath0="WPA DHCP"
1561         to
1562                 wlans_ath0=wlan0
1563                 ifconfig_wlan0="WPA DHCP"
1564         see rc.conf(5) for more details.  In addition, mergemaster of
1565         /etc/rc.d is highly recommended.  Simultaneous update of userland
1566         and kernel wouldn't hurt either.
1567
1568         As part of the multi-bss changes the wlan_scan_ap and wlan_scan_sta
1569         modules were merged into the base wlan module.  All references
1570         to these modules (e.g. in kernel config files) must be removed.
1571
1572 20080408:
1573         psm(4) has gained write(2) support in native operation level.
1574         Arbitrary commands can be written to /dev/psm%d and status can
1575         be read back from it.  Therefore, an application is responsible
1576         for status validation and error recovery.  It is a no-op in
1577         other operation levels.
1578
1579 20080312:
1580         Support for KSE threading has been removed from the kernel.  To
1581         run legacy applications linked against KSE libmap.conf may
1582         be used.  The following libmap.conf may be used to ensure
1583         compatibility with any prior release:
1584
1585         libpthread.so.1 libthr.so.1
1586         libpthread.so.2 libthr.so.2
1587         libkse.so.3 libthr.so.3
1588
1589 20080301:
1590         The layout of struct vmspace has changed. This affects libkvm
1591         and any executables that link against libkvm and use the
1592         kvm_getprocs() function. In particular, but not exclusively,
1593         it affects ps(1), fstat(1), pkill(1), systat(1), top(1) and w(1).
1594         The effects are minimal, but it's advisable to upgrade world
1595         nonetheless.
1596
1597 20080229:
1598         The latest em driver no longer has support in it for the
1599         82575 adapter, this is now moved to the igb driver. The
1600         split was done to make new features that are incompatible
1601         with older hardware easier to do.
1602
1603 20080220:
1604         The new geom_lvm(4) geom class has been renamed to geom_linux_lvm(4),
1605         likewise the kernel option is now GEOM_LINUX_LVM.
1606
1607 20080211:
1608         The default NFS mount mode has changed from UDP to TCP for
1609         increased reliability.  If you rely on (insecurely) NFS
1610         mounting across a firewall you may need to update your
1611         firewall rules.
1612
1613 20080208:
1614         Belatedly note the addition of m_collapse for compacting
1615         mbuf chains.
1616
1617 20080126:
1618         The fts(3) structures have been changed to use adequate
1619         integer types for their members and so to be able to cope
1620         with huge file trees.  The old fts(3) ABI is preserved
1621         through symbol versioning in libc, so third-party binaries
1622         using fts(3) should still work, although they will not take
1623         advantage of the extended types.  At the same time, some
1624         third-party software might fail to build after this change
1625         due to unportable assumptions made in its source code about
1626         fts(3) structure members.  Such software should be fixed
1627         by its vendor or, in the worst case, in the ports tree.
1628         FreeBSD_version 800015 marks this change for the unlikely
1629         case that a portable fix is impossible.
1630
1631 20080123:
1632         To upgrade to -current after this date, you must be running
1633         FreeBSD not older than 6.0-RELEASE.  Upgrading to -current
1634         from 5.x now requires a stop over at RELENG_6 or RELENG_7 systems.
1635
1636 20071128:
1637         The ADAPTIVE_GIANT kernel option has been retired because its
1638         functionality is the default now.
1639
1640 20071118:
1641         The AT keyboard emulation of sunkbd(4) has been turned on
1642         by default. In order to make the special symbols of the Sun
1643         keyboards driven by sunkbd(4) work under X these now have
1644         to be configured the same way as Sun USB keyboards driven
1645         by ukbd(4) (which also does AT keyboard emulation), f.e.:
1646
1647         Option  "XkbLayout" "us"
1648         Option  "XkbRules" "xorg"
1649         Option  "XkbSymbols" "pc(pc105)+sun_vndr/usb(sun_usb)+us"
1650
1651 20071024:
1652         It has been decided that it is desirable to provide ABI
1653         backwards compatibility to the FreeBSD 4/5/6 versions of the
1654         PCIOCGETCONF, PCIOCREAD and PCIOCWRITE IOCTLs, which was
1655         broken with the introduction of PCI domain support (see the
1656         20070930 entry). Unfortunately, this required the ABI of
1657         PCIOCGETCONF to be broken again in order to be able to
1658         provide backwards compatibility to the old version of that
1659         IOCTL. Thus consumers of PCIOCGETCONF have to be recompiled
1660         again. As for prominent ports this affects neither pciutils
1661         nor xorg-server this time, the hal port needs to be rebuilt
1662         however.
1663
1664 20071020:
1665         The misnamed kthread_create() and friends have been renamed
1666         to kproc_create() etc. Many of the callers already
1667         used kproc_start()..
1668         I will return kthread_create() and friends in a while
1669         with implementations that actually create threads, not procs.
1670         Renaming corresponds with version 800002.
1671
1672 20071010:
1673         RELENG_7 branched.
1674
1675 COMMON ITEMS:
1676
1677         General Notes
1678         -------------
1679         Avoid using make -j when upgrading.  While generally safe, there are
1680         sometimes problems using -j to upgrade.  If your upgrade fails with
1681         -j, please try again without -j.  From time to time in the past there
1682         have been problems using -j with buildworld and/or installworld.  This
1683         is especially true when upgrading between "distant" versions (eg one
1684         that cross a major release boundary or several minor releases, or when
1685         several months have passed on the -current branch).
1686
1687         Sometimes, obscure build problems are the result of environment
1688         poisoning.  This can happen because the make utility reads its
1689         environment when searching for values for global variables.  To run
1690         your build attempts in an "environmental clean room", prefix all make
1691         commands with 'env -i '.  See the env(1) manual page for more details.
1692
1693         When upgrading from one major version to another it is generally best
1694         to upgrade to the latest code in the currently installed branch first,
1695         then do an upgrade to the new branch. This is the best-tested upgrade
1696         path, and has the highest probability of being successful.  Please try
1697         this approach before reporting problems with a major version upgrade.
1698
1699         When upgrading a live system, having a root shell around before
1700         installing anything can help undo problems. Not having a root shell
1701         around can lead to problems if pam has changed too much from your
1702         starting point to allow continued authentication after the upgrade.
1703
1704         ZFS notes
1705         ---------
1706         When upgrading the boot ZFS pool to a new version, always follow
1707         these two steps:
1708
1709         1.) recompile and reinstall the ZFS boot loader and boot block
1710         (this is part of "make buildworld" and "make installworld")
1711
1712         2.) update the ZFS boot block on your boot drive
1713
1714         The following example updates the ZFS boot block on the first
1715         partition (freebsd-boot) of a GPT partitioned drive ad0:
1716         "gpart bootcode -p /boot/gptzfsboot -i 1 ad0"
1717
1718         Non-boot pools do not need these updates.
1719
1720         To build a kernel
1721         -----------------
1722         If you are updating from a prior version of FreeBSD (even one just
1723         a few days old), you should follow this procedure.  It is the most
1724         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1725
1726         make kernel-toolchain
1727         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1728         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1729
1730         To test a kernel once
1731         ---------------------
1732         If you just want to boot a kernel once (because you are not sure
1733         if it works, or if you want to boot a known bad kernel to provide
1734         debugging information) run
1735         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1736         nextboot -k testkernel
1737
1738         To just build a kernel when you know that it won't mess you up
1739         --------------------------------------------------------------
1740         This assumes you are already running a CURRENT system.  Replace
1741         ${arch} with the architecture of your machine (e.g. "i386",
1742         "arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
1743
1744         cd src/sys/${arch}/conf
1745         config KERNEL_NAME_HERE
1746         cd ../compile/KERNEL_NAME_HERE
1747         make depend
1748         make
1749         make install
1750
1751         If this fails, go to the "To build a kernel" section.
1752
1753         To rebuild everything and install it on the current system.
1754         -----------------------------------------------------------
1755         # Note: sometimes if you are running current you gotta do more than
1756         # is listed here if you are upgrading from a really old current.
1757
1758         <make sure you have good level 0 dumps>
1759         make buildworld
1760         make kernel KERNCONF=YOUR_KERNEL_HERE
1761                                                         [1]
1762         <reboot in single user>                         [3]
1763         mergemaster -p                                  [5]
1764         make installworld
1765         mergemaster -i                                  [4]
1766         make delete-old                                 [6]
1767         <reboot>
1768
1769         To cross-install current onto a separate partition
1770         --------------------------------------------------
1771         # In this approach we use a separate partition to hold
1772         # current's root, 'usr', and 'var' directories.   A partition
1773         # holding "/", "/usr" and "/var" should be about 2GB in
1774         # size.
1775
1776         <make sure you have good level 0 dumps>
1777         <boot into -stable>
1778         make buildworld
1779         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1780         <maybe newfs current's root partition>
1781         <mount current's root partition on directory ${CURRENT_ROOT}>
1782         make installworld DESTDIR=${CURRENT_ROOT}
1783         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1784         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1785         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
1786         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1787         <reboot into current>
1788         <do a "native" rebuild/install as described in the previous section>
1789         <maybe install compatibility libraries from ports/misc/compat*>
1790         <reboot>
1791
1792
1793         To upgrade in-place from stable to current
1794         ----------------------------------------------
1795         <make sure you have good level 0 dumps>
1796         make buildworld                                 [9]
1797         make kernel KERNCONF=YOUR_KERNEL_HERE           [8]
1798                                                         [1]
1799         <reboot in single user>                         [3]
1800         mergemaster -p                                  [5]
1801         make installworld
1802         mergemaster -i                                  [4]
1803         make delete-old                                 [6]
1804         <reboot>
1805
1806         Make sure that you've read the UPDATING file to understand the
1807         tweaks to various things you need.  At this point in the life
1808         cycle of current, things change often and you are on your own
1809         to cope.  The defaults can also change, so please read ALL of
1810         the UPDATING entries.
1811
1812         Also, if you are tracking -current, you must be subscribed to
1813         freebsd-current@freebsd.org.  Make sure that before you update
1814         your sources that you have read and understood all the recent
1815         messages there.  If in doubt, please track -stable which has
1816         much fewer pitfalls.
1817
1818         [1] If you have third party modules, such as vmware, you
1819         should disable them at this point so they don't crash your
1820         system on reboot.
1821
1822         [3] From the bootblocks, boot -s, and then do
1823                 fsck -p
1824                 mount -u /
1825                 mount -a
1826                 cd src
1827                 adjkerntz -i            # if CMOS is wall time
1828         Also, when doing a major release upgrade, it is required that
1829         you boot into single user mode to do the installworld.
1830
1831         [4] Note: This step is non-optional.  Failure to do this step
1832         can result in a significant reduction in the functionality of the
1833         system.  Attempting to do it by hand is not recommended and those
1834         that pursue this avenue should read this file carefully, as well
1835         as the archives of freebsd-current and freebsd-hackers mailing lists
1836         for potential gotchas.  The -U option is also useful to consider.
1837         See mergemaster(8) for more information.
1838
1839         [5] Usually this step is a noop.  However, from time to time
1840         you may need to do this if you get unknown user in the following
1841         step.  It never hurts to do it all the time.  You may need to
1842         install a new mergemaster (cd src/usr.sbin/mergemaster && make
1843         install) after the buildworld before this step if you last updated
1844         from current before 20130425 or from -stable before 20130430.
1845
1846         [6] This only deletes old files and directories. Old libraries
1847         can be deleted by "make delete-old-libs", but you have to make
1848         sure that no program is using those libraries anymore.
1849
1850         [8] In order to have a kernel that can run the 4.x binaries needed to
1851         do an installworld, you must include the COMPAT_FREEBSD4 option in
1852         your kernel.  Failure to do so may leave you with a system that is
1853         hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1854         required to run the 5.x binaries on more recent kernels.  And so on
1855         for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1856
1857         Make sure that you merge any new devices from GENERIC since the
1858         last time you updated your kernel config file.
1859
1860         [9] When checking out sources, you must include the -P flag to have
1861         cvs prune empty directories.
1862
1863         If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1864         "?=" instead of the "=" assignment operator, so that buildworld can
1865         override the CPUTYPE if it needs to.
1866
1867         MAKEOBJDIRPREFIX must be defined in an environment variable, and
1868         not on the command line, or in /etc/make.conf.  buildworld will
1869         warn if it is improperly defined.
1870 FORMAT:
1871
1872 This file contains a list, in reverse chronological order, of major
1873 breakages in tracking -current.  It is not guaranteed to be a complete
1874 list of such breakages, and only contains entries since October 10, 2007.
1875 If you need to see UPDATING entries from before that date, you will need
1876 to fetch an UPDATING file from an older FreeBSD release.
1877
1878 Copyright information:
1879
1880 Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1881
1882 Redistribution, publication, translation and use, with or without
1883 modification, in full or in part, in any form or format of this
1884 document are permitted without further permission from the author.
1885
1886 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1887 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1888 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1889 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1890 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1891 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1892 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1893 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1894 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1895 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1896 POSSIBILITY OF SUCH DAMAGE.
1897
1898 Contact Warner Losh if you have any questions about your use of
1899 this document.
1900
1901 $FreeBSD$