]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - UPDATING
Update libdialog to 1.3-20180621
[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     https://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 and WITH_GCC to bootstrap to
16 the tip of head, and then rebuild without this option. The bootstrap process
17 from older version of current across the gcc/clang cutover is a bit fragile.
18
19 NOTE TO PEOPLE WHO THINK THAT FreeBSD 13.x IS SLOW:
20         FreeBSD 13.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 20181015:
35         Ports for the DRM modules have been simplified. Now, amd64 users should
36         just install the drm-kmod port. All others should install
37         drm-legacy-kmod.
38
39         Graphics hardware that's newer than about 2010 usually works with
40         drm-kmod.  For hardware older than 2013, however, some users will need
41         to use drm-legacy-kmod if drm-kmod doesn't work for them. Hardware older
42         than 2008 usually only works in drm-legacy-kmod. The graphics team can
43         only commit to hardware made since 2013 due to the complexity of the
44         market and difficulty to test all the older cards effectively. If you
45         have hardware supported by drm-kmod, you are strongly encouraged to use
46         that as you will get better support.
47
48         Other than KPI chasing, drm-legacy-kmod will not be updated. As outlined
49         elsewhere, the drm and drm2 modules will be eliminated from the src base
50         soon (with a limited exception for arm). Please update to the package asap
51         and report any issues to x11@freebsd.org.
52
53         Generally, anybody using the drm*-kmod packages should add
54         WITHOUT_DRM_MODULE=t and WITHOUT_DRM2_MODULE=t to avoid nasty
55         cross-threading surprises, especially with automatic driver
56         loading from X11 startup. These will become the defaults in 13-current
57         shortly.
58
59 20181009:
60         OpenSSL has been updated to version 1.1.1.  This update included
61         additional various API changes througout the base system.  It is
62         important to rebuild third-party software after upgrading.  The value
63         of __FreeBSD_version has been bumped accordingly.
64
65 20181006:
66         The legacy DRM modules and drivers have now been added to the loader's
67         module blacklist, in favor of loading them with kld_list in rc.conf(5).
68         The module blacklist may be overridden with the loader.conf(5)
69         'module_blacklist' variable, but loading them via rc.conf(5) is strongly
70         encouraged.
71
72 20181002:
73         The cam(4) based nda(4) driver will be used over nvd(4) by default on
74         powerpc64. You may set 'options NVME_USE_NVD=1' in your kernel conf or
75         loader tunable 'hw.nvme.use_nvd=1' if you wish to use the existing
76         driver.  Make sure to edit /boot/etc/kboot.conf and fstab to use the
77         nda device name.
78
79 20180913:
80         Reproducible build mode is now on by default, in preparation for
81         FreeBSD 12.0.  This eliminates build metadata such as the user,
82         host, and time from the kernel (and uname), unless the working tree
83         corresponds to a modified checkout from a version control system.
84         The previous behavior can be obtained by setting the /etc/src.conf
85         knob WITHOUT_REPRODUCIBLE_BUILD.
86
87 20180826:
88         The Yarrow CSPRNG has been removed from the kernel as it has not been
89         supported by its designers since at least 2003. Fortuna has been the
90         default since FreeBSD-11.
91
92 20180822:
93         devctl freeze/thaw have gone into the tree, the rc scripts have been
94         updated to use them and devmatch has been changed.  You should update
95         kernel, userland and rc scripts all at the same time.
96
97 20180818:
98         The default interpreter has been switched from 4th to Lua.
99         LOADER_DEFAULT_INTERP, documented in build(7), will override the default
100         interpreter.  If you have custom FORTH code you will need to set
101         LOADER_DEFAULT_INTERP=4th (valid values are 4th, lua or simp) in
102         src.conf for the build.  This will create default hard links between
103         loader and loader_4th instead of loader and loader_lua, the new default.
104         If you are using UEFI it will create the proper hard link to loader.efi.
105
106         bhyve uses userboot.so. It remains 4th-only until some issues are solved
107         regarding coexisting with multiple versions of FreeBSD are resolved.
108
109 20180815:
110         ls(1) now respects the COLORTERM environment variable used in other
111         systems and software to indicate that a colored terminal is both
112         supported and desired.  If ls(1) is suddenly emitting colors, they may
113         be disabled again by either removing the unwanted COLORTERM from your
114         environment, or using `ls --color=never`.  The ls(1) specific CLICOLOR
115         may not be observed in a future release.
116
117 20180808:
118         The default pager for most commands has been changed to "less".  To
119         restore the old behavior, set PAGER="more" and MANPAGER="more -s" in
120         your environment.
121
122 20180731:
123         The jedec_ts(4) driver has been removed. A superset of its functionality
124         is available in the jedec_dimm(4) driver, and the manpage for that
125         driver includes migration instructions. If you have "device jedec_ts"
126         in your kernel configuration file, it must be removed.
127
128 20180730:
129         amd64/GENERIC now has EFI runtime services, EFIRT, enabled by default.
130         This should have no effect if the kernel is booted via BIOS/legacy boot.
131         EFIRT may be disabled via a loader tunable, efi.rt.disabled, if a system
132         has a buggy firmware that prevents a successful boot due to use of
133         runtime services.
134
135 20180727:
136         Atmel AT91RM9200 and AT91SAM9, Cavium CNS 11xx and XScale
137         support has been removed from the tree. These ports were
138         obsolete and/or known to be broken for many years.
139
140 20180723:
141         loader.efi has been augmented to participate more fully in the
142         UEFI boot manager protocol. loader.efi will now look at the
143         BootXXXX environment variable to determine if a specific kernel
144         or root partition was specified. XXXX is derived from BootCurrent.
145         efibootmgr(8) manages these standard UEFI variables.
146
147 20180720:
148         zfsloader's functionality has now been folded into loader.
149         zfsloader is no longer necessary once you've updated your
150         boot blocks. For a transition period, we will install a
151         hardlink for zfsloader to loader to allow a smooth transition
152         until the boot blocks can be updated (hard link because old
153         zfs boot blocks don't understand symlinks).
154
155 20180719:
156         ARM64 now have efifb support, if you want to have serial console
157         on your arm64 board when an screen is connected and the bootloader
158         setup a frambuffer for us to use, just add :
159         boot_serial=YES
160         boot_multicons=YES
161         in /boot/loader.conf
162         For Raspberry Pi 3 (RPI) users, this is needed even if you don't have
163         an screen connected as the firmware will setup a framebuffer are that
164         u-boot will expose as an EFI framebuffer.
165
166 20180719:
167         New uid:gid added, ntpd:ntpd (123:123).  Be sure to run mergemaster
168         or take steps to update /etc/passwd before doing installworld on
169         existing systems.  Do not skip the "mergemaster -Fp" step before
170         installworld, as described in the update procedures near the bottom
171         of this document.  Also, rc.d/ntpd now starts ntpd(8) as user ntpd
172         if the new mac_ntpd(4) policy is available, unless ntpd_flags or
173         the ntp config file contain options that change file/dir locations.
174         When such options (e.g., "statsdir" or "crypto") are used, ntpd can
175         still be run as non-root by setting ntpd_user=ntpd in rc.conf, after
176         taking steps to ensure that all required files/dirs are accessible
177         by the ntpd user.
178
179 20180717:
180         Big endian arm support has been removed.
181
182 20180711:
183         The static environment setup in kernel configs is no longer mutually
184         exclusive with the loader(8) environment by default.  In order to
185         restore the previous default behavior of disabling the loader(8)
186         environment if a static environment is present, you must specify
187         loader_env.disabled=1 in the static environment.
188
189 20180705:
190         The ABI of syscalls used by management tools like sockstat and
191         netstat has been broken to allow 32-bit binaries to work on
192         64-bit kernels without modification.  These programs will need
193         to match the kernel in order to function.  External programs may
194         require minor modifications to accommodate a change of type in
195         structures from pointers to 64-bit virtual addresses.
196
197 20180702:
198         On i386 and amd64 atomics are now inlined. Out of tree modules using
199         atomics will need to be rebuilt.
200
201 20180701:
202         The '%I' format in the kern.corefile sysctl limits the number of
203         core files that a process can generate to the number stored in the
204         debug.ncores sysctl. The '%I' format is replaced by the single digit
205         index. Previously, if all indexes were taken the kernel would overwrite
206         only a core file with the highest index in a filename.
207         Currently the system will create a new core file if there is a free
208         index or if all slots are taken it will overwrite the oldest one.
209
210 20180630:
211         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
212         6.0.1.  Please see the 20141231 entry below for information about
213         prerequisites and upgrading, if you are not already using clang 3.5.0
214         or higher.
215
216 20180628:
217         r335753 introduced a new quoting method. However, etc/devd/devmatch.conf
218         needed to be changed to work with it. This change was made with r335763
219         and requires a mergemaster / etcupdate / etc to update the installed file.
220
221 20180612:
222         r334930 changed the interface between the NFS modules, so they all
223         need to be rebuilt.  r335018 did a __FreeBSD_version bump for this.
224
225 20180530:
226         As of r334391 lld is the default amd64 system linker; it is installed
227         as /usr/bin/ld.  Kernel build workarounds (see 20180510 entry) are no
228         longer necessary.
229
230 20180530:
231         The kernel / userland interface for devinfo changed, so you'll
232         need a new kernel and userland as a pair for it to work (rebuilding
233         lib/libdevinfo is all that's required). devinfo and devmatch will
234         not work, but everything else will when there's a mismatch.
235
236 20180523:
237         The on-disk format for hwpmc callchain records has changed to include
238         threadid corresponding to a given record. This changes the field offsets
239         and thus requires that libpmcstat be rebuilt before using a kernel
240         later than r334108.
241
242 20180517:
243         The vxge(4) driver has been removed.  This driver was introduced into
244         HEAD one week before the Exar left the Ethernet market and is not
245         known to be used.  If you have device vxge in your kernel config file
246         it must be removed.
247
248 20180510:
249         The amd64 kernel now requires a ld that supports ifunc to produce a
250         working kernel, either lld or a newer binutils. lld is built by default
251         on amd64, and the 'buildkernel' target uses it automatically. However,
252         it is not the default linker, so building the kernel the traditional
253         way requires LD=ld.lld on the command line (or LD=/usr/local/bin/ld for
254         binutils port/package). lld will soon be default, and this requirement
255         will go away.
256
257         NOTE: As of r334391 lld is the default system linker on amd64, and no
258         workaround is necessary.
259
260 20180508:
261         The nxge(4) driver has been removed.  This driver was for PCI-X 10g
262         cards made by s2io/Neterion.  The company was aquired by Exar and
263         no longer sells or supports Ethernet products.  If you have device
264         nxge in your kernel config file it must be removed.
265
266 20180504:
267         The tz database (tzdb) has been updated to 2018e.  This version more
268         correctly models time stamps in time zones with negative DST such as
269         Europe/Dublin (from 1971 on), Europe/Prague (1946/7), and
270         Africa/Windhoek (1994/2017).  This does not affect the UT offsets, only
271         time zone abbreviations and the tm_isdst flag.
272
273 20180502:
274         The ixgb(4) driver has been removed.  This driver was for an early and
275         uncommon legacy PCI 10GbE for a single ASIC, Intel 82597EX. Intel
276         quickly shifted to the long lived ixgbe family.  If you have device
277         ixgb in your kernel config file it must be removed.
278
279 20180501:
280         The lmc(4) driver has been removed.  This was a WAN interface
281         card that was already reportedly rare in 2003, and had an ambiguous
282         license.  If you have device lmc in your kernel config file it must
283         be removed.
284
285 20180413:
286         Support for Arcnet networks has been removed.  If you have device
287         arcnet or device cm in your kernel config file they must be
288         removed.
289
290 20180411:
291         Support for FDDI networks has been removed.  If you have device
292         fddi or device fpa in your kernel config file they must be
293         removed.
294
295 20180406:
296         In addition to supporting RFC 3164 formatted messages, the
297         syslogd(8) service is now capable of parsing RFC 5424 formatted
298         log messages. The main benefit of using RFC 5424 is that clients
299         may now send log messages with timestamps containing year numbers,
300         microseconds and time zone offsets.
301
302         Similarly, the syslog(3) C library function has been altered to
303         send RFC 5424 formatted messages to the local system logging
304         daemon. On systems using syslogd(8), this change should have no
305         negative impact, as long as syslogd(8) and the C library are
306         updated at the same time. On systems using a different system
307         logging daemon, it may be necessary to make configuration
308         adjustments, depending on the software used.
309
310         When using syslog-ng, add the 'syslog-protocol' flag to local
311         input sources to enable parsing of RFC 5424 formatted messages:
312
313                 source src {
314                         unix-dgram("/var/run/log" flags(syslog-protocol));
315                 }
316
317         When using rsyslog, disable the 'SysSock.UseSpecialParser' option
318         of the 'imuxsock' module to let messages be processed by the
319         regular RFC 3164/5424 parsing pipeline:
320
321                 module(load="imuxsock" SysSock.UseSpecialParser="off")
322
323         Do note that these changes only affect communication between local
324         applications and syslogd(8). The format that syslogd(8) uses to
325         store messages on disk or forward messages to other systems
326         remains unchanged. syslogd(8) still uses RFC 3164 for these
327         purposes. Options to customize this behaviour will be added in the
328         future. Utilities that process log files stored in /var/log are
329         thus expected to continue to function as before.
330
331         __FreeBSD_version has been incremented to 1200061 to denote this
332         change.
333
334 20180328:
335         Support for token ring networks has been removed. If you
336         have "device token" in your kernel config you should remove
337         it. No device drivers supported token ring.
338
339 20180323:
340         makefs was modified to be able to tag ISO9660 El Torito boot catalog
341         entries as EFI instead of overloading the i386 tag as done previously.
342         The amd64 mkisoimages.sh script used to build amd64 ISO images for
343         release was updated to use this. This may mean that makefs must be
344         updated before "make cdrom" can be run in the release directory. This
345         should be as simple as:
346
347                 $ cd $SRCDIR/usr.sbin/makefs
348                 $ make depend all install
349
350 20180212:
351         FreeBSD boot loader enhanced with Lua scripting. It's purely opt-in for
352         now by building WITH_LOADER_LUA and WITHOUT_FORTH in /etc/src.conf.
353         Co-existance for the transition period will come shortly. Booting is a
354         complex environment and test coverage for Lua-enabled loaders has been
355         thin, so it would be prudent to assume it might not work and make
356         provisions for backup boot methods.
357
358 20180211:
359         devmatch functionality has been turned on in devd. It will automatically
360         load drivers for unattached devices. This may cause unexpected drivers to
361         be loaded. Please report any problems to current@ and imp@freebsd.org.
362
363 20180114:
364         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
365         6.0.0.  Please see the 20141231 entry below for information about
366         prerequisites and upgrading, if you are not already using clang 3.5.0
367         or higher.
368
369 20180110:
370         LLVM's lld linker is now used as the FreeBSD/amd64 bootstrap linker.
371         This means it is used to link the kernel and userland libraries and
372         executables, but is not yet installed as /usr/bin/ld by default.
373
374         To revert to ld.bfd as the bootstrap linker, in /etc/src.conf set
375         WITHOUT_LLD_BOOTSTRAP=yes
376
377 20180110:
378         On i386, pmtimer has been removed. Its functionality has been folded
379         into apm. It was a no-op on ACPI in current for a while now (but was still
380         needed on i386 in FreeBSD 11 and earlier). Users may need to remove it
381         from kernel config files.
382
383 20180104:
384         The use of RSS hash from the network card aka flowid has been
385         disabled by default for lagg(4) as it's currently incompatible with
386         the lacp and loadbalance protocols.
387
388         This can be re-enabled by setting the following in loader.conf:
389         net.link.lagg.default_use_flowid="1"
390
391 20180102:
392         The SW_WATCHDOG option is no longer necessary to enable the
393         hardclock-based software watchdog if no hardware watchdog is
394         configured. As before, SW_WATCHDOG will cause the software
395         watchdog to be enabled even if a hardware watchdog is configured.
396
397 20171215:
398         r326887 fixes the issue described in the 20171214 UPDATING entry.
399         r326888 flips the switch back to building GELI support always.
400
401 20171214:
402         r362593 broke ZFS + GELI support for reasons unknown. However,
403         it also broke ZFS support generally, so GELI has been turned off
404         by default as the lesser evil in r326857. If you boot off ZFS and/or
405         GELI, it might not be a good time to update.
406
407 20171125:
408         PowerPC users must update loader(8) by rebuilding world before
409         installing a new kernel, as the protocol connecting them has
410         changed. Without the update, loader metadata will not be passed
411         successfully to the kernel and users will have to enter their
412         root partition at the kernel mountroot prompt to continue booting.
413         Newer versions of loader can boot old kernels without issue.
414
415 20171110:
416         The LOADER_FIREWIRE_SUPPORT build variable as been renamed to
417         WITH/OUT_LOADER_FIREWIRE. LOADER_{NO_,}GELI_SUPPORT has been renamed
418         to WITH/OUT_LOADER_GELI.
419
420 20171106:
421         The naive and non-compliant support of posix_fallocate(2) in ZFS
422         has been removed as of r325320.  The system call now returns EINVAL
423         when used on a ZFS file.  Although the new behavior complies with the
424         standard, some consumers are not prepared to cope with it.
425         One known victim is lld prior to r325420.
426
427 20171102:
428         Building in a FreeBSD src checkout will automatically create object
429         directories now rather than store files in the current directory if
430         'make obj' was not ran.  Calling 'make obj' is no longer necessary.
431         This feature can be disabled by setting WITHOUT_AUTO_OBJ=yes in
432         /etc/src-env.conf (not /etc/src.conf), or passing the option in the
433         environment.
434
435 20171101:
436         The default MAKEOBJDIR has changed from /usr/obj/<srcdir> for native
437         builds, and /usr/obj/<arch>/<srcdir> for cross-builds, to a unified
438         /usr/obj/<srcdir>/<arch>.  This behavior can be changed to the old
439         format by setting WITHOUT_UNIFIED_OBJDIR=yes in /etc/src-env.conf,
440         the environment, or with -DWITHOUT_UNIFIED_OBJDIR when building.
441         The UNIFIED_OBJDIR option is a transitional feature that will be
442         removed for 12.0 release; please migrate to the new format for any
443         tools by looking up the OBJDIR used by 'make -V .OBJDIR' means rather
444         than hardcoding paths.
445
446 20171028:
447         The native-xtools target no longer installs the files by default to the
448         OBJDIR.  Use the native-xtools-install target with a DESTDIR to install
449         to ${DESTDIR}/${NXTP} where NXTP defaults to /nxb-bin.
450
451 20171021:
452         As part of the boot loader infrastructure cleanup, LOADER_*_SUPPORT
453         options are changing from controlling the build if defined / undefined
454         to controlling the build with explicit 'yes' or 'no' values. They will
455         shift to WITH/WITHOUT options to match other options in the system.
456
457 20171010:
458         libstand has turned into a private library for sys/boot use only.
459         It is no longer supported as a public interface outside of sys/boot.
460
461 20171005:
462         The arm port has split armv6 into armv6 and armv7. armv7 is now
463         a valid TARGET_ARCH/MACHINE_ARCH setting. If you have an armv7 system
464         and are running a kernel from before r324363, you will need to add
465         MACHINE_ARCH=armv7 to 'make buildworld' to do a native build.
466
467 20171003:
468         When building multiple kernels using KERNCONF, non-existent KERNCONF
469         files will produce an error and buildkernel will fail. Previously
470         missing KERNCONF files silently failed giving no indication as to
471         why, only to subsequently discover during installkernel that the
472         desired kernel was never built in the first place.
473
474 20170912:
475         The default serial number format for CTL LUNs has changed.  This will
476         affect users who use /dev/diskid/* device nodes, or whose FibreChannel
477         or iSCSI clients care about their LUNs' serial numbers.  Users who
478         require serial number stability should hardcode serial numbers in
479         /etc/ctl.conf .
480
481 20170912:
482         For 32-bit arm compiled for hard-float support, soft-floating point
483         binaries now always get their shared libraries from
484         LD_SOFT_LIBRARY_PATH (in the past, this was only used if
485         /usr/libsoft also existed). Only users with a hard-float ld.so, but
486         soft-float everything else should be affected.
487
488 20170826:
489         The geli password typed at boot is now hidden.  To restore the previous
490         behavior, see geli(8) for configuration options.
491
492 20170825:
493         Move PMTUD blackhole counters to TCPSTATS and remove them from bare
494         sysctl values.  Minor nit, but requires a rebuild of both world/kernel
495         to complete.
496
497 20170814:
498         "make check" behavior (made in ^/head@r295380) has been changed to
499         execute from a limited sandbox, as opposed to executing from
500         ${TESTSDIR}.
501
502         Behavioral changes:
503         - The "beforecheck" and "aftercheck" targets are now specified.
504         - ${CHECKDIR} (added in commit noted above) has been removed.
505         - Legacy behavior can be enabled by setting
506           WITHOUT_MAKE_CHECK_USE_SANDBOX in src.conf(5) or the environment.
507
508         If the limited sandbox mode is enabled, "make check" will execute
509         "make distribution", then install, execute the tests, and clean up the
510         sandbox if successful.
511
512         The "make distribution" and "make install" targets are typically run as
513         root to set appropriate permissions and ownership at installation time.
514         The end-user should set "WITH_INSTALL_AS_USER" in src.conf(5) or the
515         environment if executing "make check" with limited sandbox mode using
516         an unprivileged user.
517
518 20170808:
519         Since the switch to GPT disk labels, fsck for UFS/FFS has been
520         unable to automatically find alternate superblocks. As of r322297,
521         the information needed to find alternate superblocks has been
522         moved to the end of the area reserved for the boot block.
523         Filesystems created with a newfs of this vintage or later
524         will create the recovery information. If you have a filesystem
525         created prior to this change and wish to have a recovery block
526         created for your filesystem, you can do so by running fsck in
527         foreground mode (i.e., do not use the -p or -y options). As it
528         starts, fsck will ask ``SAVE DATA TO FIND ALTERNATE SUPERBLOCKS''
529         to which you should answer yes.
530
531 20170728:
532         As of r321665, an NFSv4 server configuration that services
533         Kerberos mounts or clients that do not support the uid/gid in
534         owner/owner_group string capability, must explicitly enable
535         the nfsuserd daemon by adding nfsuserd_enable="YES" to the
536         machine's /etc/rc.conf file.
537
538 20170722:
539         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 5.0.0.
540         Please see the 20141231 entry below for information about prerequisites
541         and upgrading, if you are not already using clang 3.5.0 or higher.
542
543 20170701:
544         WITHOUT_RCMDS is now the default. Set WITH_RCMDS if you need the
545         r-commands (rlogin, rsh, etc.) to be built with the base system.
546
547 20170625:
548         The FreeBSD/powerpc platform now uses a 64-bit type for time_t.  This is
549         a very major ABI incompatible change, so users of FreeBSD/powerpc must
550         be careful when performing source upgrades.  It is best to run
551         'make installworld' from an alternate root system, either a live
552         CD/memory stick, or a temporary root partition.  Additionally, all ports
553         must be recompiled.  powerpc64 is largely unaffected, except in the case
554         of 32-bit compatibility.  All 32-bit binaries will be affected.
555
556 20170623:
557         Forward compatibility for the "ino64" project have been committed. This
558         will allow most new binaries to run on older kernels in a limited
559         fashion.  This prevents many of the common foot-shooting actions in the
560         upgrade as well as the limited ability to roll back the kernel across
561         the ino64 upgrade. Complicated use cases may not work properly, though
562         enough simpler ones work to allow recovery in most situations.
563
564 20170620:
565         Switch back to the BSDL dtc (Device Tree Compiler). Set WITH_GPL_DTC
566         if you require the GPL compiler.
567
568 20170618:
569         The internal ABI used for communication between the NFS kernel modules
570         was changed by r320085, so __FreeBSD_version was bumped to
571         ensure all the NFS related modules are updated together.
572
573 20170617:
574         The ABI of struct event was changed by extending the data
575         member to 64bit and adding ext fields.  For upgrade, same
576         precautions as for the entry 20170523 "ino64" must be
577         followed.
578
579 20170531:
580         The GNU roff toolchain has been removed from base. To render manpages
581         which are not supported by mandoc(1), man(1) can fallback on GNU roff
582         from ports (and recommends to install it).
583         To render roff(7) documents, consider using GNU roff from ports or the
584         heirloom doctools roff toolchain from ports via pkg install groff or
585         via pkg install heirloom-doctools.
586
587 20170524:
588         The ath(4) and ath_hal(4) modules now build piecemeal to allow for
589         smaller runtime footprint builds.  This is useful for embedded systems
590         which only require one chipset support.
591
592         If you load it as a module, make sure this is in /boot/loader.conf:
593
594         if_ath_load="YES"
595
596         This will load the HAL, all chip/RF backends and if_ath_pci.
597         If you have if_ath_pci in /boot/loader.conf, ensure it is after
598         if_ath or it will not load any HAL chipset support.
599
600         If you want to selectively load things (eg on ye cheape ARM/MIPS
601         platforms where RAM is at a premium) you should:
602
603         * load ath_hal
604         * load the chip modules in question
605         * load ath_rate, ath_dfs
606         * load ath_main
607         * load if_ath_pci and/or if_ath_ahb depending upon your particular
608           bus bind type - this is where probe/attach is done.
609
610         For further comments/feedback, poke adrian@ .
611
612 20170523:
613         The "ino64" 64-bit inode project has been committed, which extends
614         a number of types to 64 bits.  Upgrading in place requires care and
615         adherence to the documented upgrade procedure.
616
617         If using a custom kernel configuration ensure that the
618         COMPAT_FREEBSD11 option is included (as during the upgrade the
619         system will be running the ino64 kernel with the existing world).
620
621         For the safest in-place upgrade begin by removing previous build
622         artifacts via "rm -rf /usr/obj/*".   Then, carefully follow the
623         full procedure documented below under the heading "To rebuild
624         everything and install it on the current system."  Specifically,
625         a reboot is required after installing the new kernel before
626         installing world.
627
628 20170424:
629         The NATM framework including the en(4), fatm(4), hatm(4), and
630         patm(4) devices has been removed.  Consumers should plan a
631         migration before the end-of-life date for FreeBSD 11.
632
633 20170420:
634         GNU diff has been replaced by a BSD licensed diff. Some features of GNU
635         diff has not been implemented, if those are needed a newer version of
636         GNU diff is available via the diffutils package under the gdiff name.
637
638 20170413:
639         As of r316810 for ipfilter, keep frags is no longer assumed when
640         keep state is specified in a rule. r316810 aligns ipfilter with
641         documentation in man pages separating keep frags from keep state.
642         This allows keep state to be specified without forcing keep frags
643         and allows keep frags to be specified independently of keep state.
644         To maintain previous behaviour, also specify keep frags with
645         keep state (as documented in ipf.conf.5).
646
647 20170407:
648         arm64 builds now use the base system LLD 4.0.0 linker by default,
649         instead of requiring that the aarch64-binutils port or package be
650         installed. To continue using aarch64-binutils, set
651         CROSS_BINUTILS_PREFIX=/usr/local/aarch64-freebsd/bin .
652
653 20170405:
654         The UDP optimization in entry 20160818 that added the sysctl
655         net.inet.udp.require_l2_bcast has been reverted.  L2 broadcast
656         packets will no longer be treated as L3 broadcast packets.
657
658 20170331:
659         Binds and sends to the loopback addresses, IPv6 and IPv4, will now
660         use any explicitly assigned loopback address available in the jail
661         instead of using the first assigned address of the jail.
662
663 20170329:
664         The ctl.ko module no longer implements the iSCSI target frontend:
665         cfiscsi.ko does instead.
666
667         If building cfiscsi.ko as a kernel module, the module can be loaded
668         via one of the following methods:
669         - `cfiscsi_load="YES"` in loader.conf(5).
670         - Add `cfiscsi` to `$kld_list` in rc.conf(5).
671         - ctladm(8)/ctld(8), when compiled with iSCSI support
672           (`WITH_ISCSI=yes` in src.conf(5))
673
674         Please see cfiscsi(4) for more details.
675
676 20170316:
677         The mmcsd.ko module now additionally depends on geom_flashmap.ko.
678         Also, mmc.ko and mmcsd.ko need to be a matching pair built from the
679         same source (previously, the dependency of mmcsd.ko on mmc.ko was
680         missing, but mmcsd.ko now will refuse to load if it is incompatible
681         with mmc.ko).
682
683 20170315:
684         The syntax of ipfw(8) named states was changed to avoid ambiguity.
685         If you have used named states in the firewall rules, you need to modify
686         them after installworld and before rebooting. Now named states must
687         be prefixed with colon.
688
689 20170311:
690         The old drm (sys/dev/drm/) drivers for i915 and radeon have been
691         removed as the userland we provide cannot use them. The KMS version
692         (sys/dev/drm2) supports the same hardware.
693
694 20170302:
695         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 4.0.0.
696         Please see the 20141231 entry below for information about prerequisites
697         and upgrading, if you are not already using clang 3.5.0 or higher.
698
699 20170221:
700         The code that provides support for ZFS .zfs/ directory functionality
701         has been reimplemented.  It's not possible now to create a snapshot
702         by mkdir under .zfs/snapshot/.  That should be the only user visible
703         change.
704
705 20170216:
706         EISA bus support has been removed. The WITH_EISA option is no longer
707         valid.
708
709 20170215:
710         MCA bus support has been removed.
711
712 20170127:
713         The WITH_LLD_AS_LD / WITHOUT_LLD_AS_LD build knobs have been renamed
714         WITH_LLD_IS_LD / WITHOUT_LLD_IS_LD, for consistency with CLANG_IS_CC.
715
716 20170112:
717         The EM_MULTIQUEUE kernel configuration option is deprecated now that
718         the em(4) driver conforms to iflib specifications.
719
720 20170109:
721         The igb(4), em(4) and lem(4) ethernet drivers are now implemented via
722         IFLIB.  If you have a custom kernel configuration that excludes em(4)
723         but you use igb(4), you need to re-add em(4) to your custom configuration.
724
725 20161217:
726         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.1.
727         Please see the 20141231 entry below for information about prerequisites
728         and upgrading, if you are not already using clang 3.5.0 or higher.
729
730 20161124:
731         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.0.
732         Please see the 20141231 entry below for information about prerequisites
733         and upgrading, if you are not already using clang 3.5.0 or higher.
734
735 20161119:
736         The layout of the pmap structure has changed for powerpc to put the pmap
737         statistics at the front for all CPU variations.  libkvm(3) and all tools
738         that link against it need to be recompiled.
739
740 20161030:
741         isl(4) and cyapa(4) drivers now require a new driver,
742         chromebook_platform(4), to work properly on Chromebook-class hardware.
743         On other types of hardware the drivers may need to be configured using
744         device hints.  Please see the corresponding manual pages for details.
745
746 20161017:
747         The urtwn(4) driver was merged into rtwn(4) and now consists of
748         rtwn(4) main module + rtwn_usb(4) and rtwn_pci(4) bus-specific
749         parts.
750         Also, firmware for RTL8188CE was renamed due to possible name
751         conflict (rtwnrtl8192cU(B) -> rtwnrtl8192cE(B))
752
753 20161015:
754         GNU rcs has been removed from base.  It is available as packages:
755         - rcs: Latest GPLv3 GNU rcs version.
756         - rcs57: Copy of the latest version of GNU rcs (GPLv2) before it was
757         removed from base.
758
759 20161008:
760         Use of the cc_cdg, cc_chd, cc_hd, or cc_vegas congestion control
761         modules now requires that the kernel configuration contain the
762         TCP_HHOOK option. (This option is included in the GENERIC kernel.)
763
764 20161003:
765         The WITHOUT_ELFCOPY_AS_OBJCOPY src.conf(5) knob has been retired.
766         ELF Tool Chain's elfcopy is always installed as /usr/bin/objcopy.
767
768 20160924:
769         Relocatable object files with the extension of .So have been renamed
770         to use an extension of .pico instead.  The purpose of this change is
771         to avoid a name clash with shared libraries on case-insensitive file
772         systems.  On those file systems, foo.So is the same file as foo.so.
773
774 20160918:
775         GNU rcs has been turned off by default.  It can (temporarily) be built
776         again by adding WITH_RCS knob in src.conf.
777         Otherwise, GNU rcs is available from packages:
778         - rcs: Latest GPLv3 GNU rcs version.
779         - rcs57: Copy of the latest version of GNU rcs (GPLv2) from base.
780
781 20160918:
782         The backup_uses_rcs functionality has been removed from rc.subr.
783
784 20160908:
785         The queue(3) debugging macro, QUEUE_MACRO_DEBUG, has been split into
786         two separate components, QUEUE_MACRO_DEBUG_TRACE and
787         QUEUE_MACRO_DEBUG_TRASH.  Define both for the original
788         QUEUE_MACRO_DEBUG behavior.
789
790 20160824:
791         r304787 changed some ioctl interfaces between the iSCSI userspace
792         programs and the kernel.  ctladm, ctld, iscsictl, and iscsid must be
793         rebuilt to work with new kernels.  __FreeBSD_version has been bumped
794         to 1200005.
795
796 20160818:
797         The UDP receive code has been updated to only treat incoming UDP
798         packets that were addressed to an L2 broadcast address as L3
799         broadcast packets.  It is not expected that this will affect any
800         standards-conforming UDP application.  The new behaviour can be
801         disabled by setting the sysctl net.inet.udp.require_l2_bcast to
802         0.
803
804 20160818:
805         Remove the openbsd_poll system call.
806         __FreeBSD_version has been bumped because of this.
807
808 20160708:
809         The stable/11 branch has been created from head@r302406.
810
811 20160622:
812         The libc stub for the pipe(2) system call has been replaced with
813         a wrapper that calls the pipe2(2) system call and the pipe(2)
814         system call is now only implemented by the kernels that include
815         "options COMPAT_FREEBSD10" in their config file (this is the
816         default).  Users should ensure that this option is enabled in
817         their kernel or upgrade userspace to r302092 before upgrading their
818         kernel.
819
820 20160527:
821         CAM will now strip leading spaces from SCSI disks' serial numbers.
822         This will affect users who create UFS filesystems on SCSI disks using
823         those disk's diskid device nodes.  For example, if /etc/fstab
824         previously contained a line like
825         "/dev/diskid/DISK-%20%20%20%20%20%20%20ABCDEFG0123456", you should
826         change it to "/dev/diskid/DISK-ABCDEFG0123456".  Users of geom
827         transforms like gmirror may also be affected.  ZFS users should
828         generally be fine.
829
830 20160523:
831         The bitstring(3) API has been updated with new functionality and
832         improved performance.  But it is binary-incompatible with the old API.
833         Objects built with the new headers may not be linked against objects
834         built with the old headers.
835
836 20160520:
837         The brk and sbrk functions have been removed from libc on arm64.
838         Binutils from ports has been updated to not link to these
839         functions and should be updated to the latest version before
840         installing a new libc.
841
842 20160517:
843         The armv6 port now defaults to hard float ABI. Limited support
844         for running both hardfloat and soft float on the same system
845         is available using the libraries installed with -DWITH_LIBSOFT.
846         This has only been tested as an upgrade path for installworld
847         and packages may fail or need manual intervention to run. New
848         packages will be needed.
849
850         To update an existing self-hosted armv6hf system, you must add
851         TARGET_ARCH=armv6 on the make command line for both the build
852         and the install steps.
853
854 20160510:
855         Kernel modules compiled outside of a kernel build now default to
856         installing to /boot/modules instead of /boot/kernel.  Many kernel
857         modules built this way (such as those in ports) already overrode
858         KMODDIR explicitly to install into /boot/modules.  However,
859         manually building and installing a module from /sys/modules will
860         now install to /boot/modules instead of /boot/kernel.
861
862 20160414:
863         The CAM I/O scheduler has been committed to the kernel. There should be
864         no user visible impact. This does enable NCQ Trim on ada SSDs. While the
865         list of known rogues that claim support for this but actually corrupt
866         data is believed to be complete, be on the lookout for data
867         corruption. The known rogue list is believed to be complete:
868
869                 o Crucial MX100, M550 drives with MU01 firmware.
870                 o Micron M510 and M550 drives with MU01 firmware.
871                 o Micron M500 prior to MU07 firmware
872                 o Samsung 830, 840, and 850 all firmwares
873                 o FCCT M500 all firmwares
874
875         Crucial has firmware http://www.crucial.com/usa/en/support-ssd-firmware
876         with working NCQ TRIM. For Micron branded drives, see your sales rep for
877         updated firmware. Black listed drives will work correctly because these
878         drives work correctly so long as no NCQ TRIMs are sent to them. Given
879         this list is the same as found in Linux, it's believed there are no
880         other rogues in the market place. All other models from the above
881         vendors work.
882
883         To be safe, if you are at all concerned, you can quirk each of your
884         drives to prevent NCQ from being sent by setting:
885                 kern.cam.ada.X.quirks="0x2"
886         in loader.conf. If the drive requires the 4k sector quirk, set the
887         quirks entry to 0x3.
888
889 20160330:
890         The FAST_DEPEND build option has been removed and its functionality is
891         now the one true way.  The old mkdep(1) style of 'make depend' has
892         been removed.  See 20160311 for further details.
893
894 20160317:
895         Resource range types have grown from unsigned long to uintmax_t.  All
896         drivers, and anything using libdevinfo, need to be recompiled.
897
898 20160311:
899         WITH_FAST_DEPEND is now enabled by default for in-tree and out-of-tree
900         builds.  It no longer runs mkdep(1) during 'make depend', and the
901         'make depend' stage can safely be skipped now as it is auto ran
902         when building 'make all' and will generate all SRCS and DPSRCS before
903         building anything else.  Dependencies are gathered at compile time with
904         -MF flags kept in separate .depend files per object file.  Users should
905         run 'make cleandepend' once if using -DNO_CLEAN to clean out older
906         stale .depend files.
907
908 20160306:
909         On amd64, clang 3.8.0 can now insert sections of type AMD64_UNWIND into
910         kernel modules.  Therefore, if you load any kernel modules at boot time,
911         please install the boot loaders after you install the kernel, but before
912         rebooting, e.g.:
913
914         make buildworld
915         make buildkernel KERNCONF=YOUR_KERNEL_HERE
916         make installkernel KERNCONF=YOUR_KERNEL_HERE
917         make -C sys/boot install
918         <reboot in single user>
919
920         Then follow the usual steps, described in the General Notes section,
921         below.
922
923 20160305:
924         Clang, llvm, lldb and compiler-rt have been upgraded to 3.8.0.  Please
925         see the 20141231 entry below for information about prerequisites and
926         upgrading, if you are not already using clang 3.5.0 or higher.
927
928 20160301:
929         The AIO subsystem is now a standard part of the kernel.  The
930         VFS_AIO kernel option and aio.ko kernel module have been removed.
931         Due to stability concerns, asynchronous I/O requests are only
932         permitted on sockets and raw disks by default.  To enable
933         asynchronous I/O requests on all file types, set the
934         vfs.aio.enable_unsafe sysctl to a non-zero value.
935
936 20160226:
937         The ELF object manipulation tool objcopy is now provided by the
938         ELF Tool Chain project rather than by GNU binutils. It should be a
939         drop-in replacement, with the addition of arm64 support. The
940         (temporary) src.conf knob WITHOUT_ELFCOPY_AS_OBJCOPY knob may be set
941         to obtain the GNU version if necessary.
942
943 20160129:
944         Building ZFS pools on top of zvols is prohibited by default.  That
945         feature has never worked safely; it's always been prone to deadlocks.
946         Using a zvol as the backing store for a VM guest's virtual disk will
947         still work, even if the guest is using ZFS.  Legacy behavior can be
948         restored by setting vfs.zfs.vol.recursive=1.
949
950 20160119:
951         The NONE and HPN patches has been removed from OpenSSH.  They are
952         still available in the security/openssh-portable port.
953
954 20160113:
955         With the addition of ypldap(8), a new _ypldap user is now required
956         during installworld. "mergemaster -p" can be used to add the user
957         prior to installworld, as documented in the handbook.
958
959 20151216:
960         The tftp loader (pxeboot) now uses the option root-path directive. As a
961         consequence it no longer looks for a pxeboot.4th file on the tftp
962         server. Instead it uses the regular /boot infrastructure as with the
963         other loaders.
964
965 20151211:
966         The code to start recording plug and play data into the modules has
967         been committed. While the old tools will properly build a new kernel,
968         a number of warnings about "unknown metadata record 4" will be produced
969         for an older kldxref. To avoid such warnings, make sure to rebuild
970         the kernel toolchain (or world). Make sure that you have r292078 or
971         later when trying to build 292077 or later before rebuilding.
972
973 20151207:
974         Debug data files are now built by default with 'make buildworld' and
975         installed with 'make installworld'. This facilitates debugging but
976         requires more disk space both during the build and for the installed
977         world. Debug files may be disabled by setting WITHOUT_DEBUG_FILES=yes
978         in src.conf(5).
979
980 20151130:
981         r291527 changed the internal interface between the nfsd.ko and
982         nfscommon.ko modules. As such, they must both be upgraded to-gether.
983         __FreeBSD_version has been bumped because of this.
984
985 20151108:
986         Add support for unicode collation strings leads to a change of
987         order of files listed by ls(1) for example. To get back to the old
988         behaviour, set LC_COLLATE environment variable to "C".
989
990         Databases administrators will need to reindex their databases given
991         collation results will be different.
992
993         Due to a bug in install(1) it is recommended to remove the ancient
994         locales before running make installworld.
995
996         rm -rf /usr/share/locale/*
997
998 20151030:
999         The OpenSSL has been upgraded to 1.0.2d.  Any binaries requiring
1000         libcrypto.so.7 or libssl.so.7 must be recompiled.
1001
1002 20151020:
1003         Qlogic 24xx/25xx firmware images were updated from 5.5.0 to 7.3.0.
1004         Kernel modules isp_2400_multi and isp_2500_multi were removed and
1005         should be replaced with isp_2400 and isp_2500 modules respectively.
1006
1007 20151017:
1008         The build previously allowed using 'make -n' to not recurse into
1009         sub-directories while showing what commands would be executed, and
1010         'make -n -n' to recursively show commands.  Now 'make -n' will recurse
1011         and 'make -N' will not.
1012
1013 20151012:
1014         If you specify SENDMAIL_MC or SENDMAIL_CF in make.conf, mergemaster
1015         and etcupdate will now use this file. A custom sendmail.cf is now
1016         updated via this mechanism rather than via installworld.  If you had
1017         excluded sendmail.cf in mergemaster.rc or etcupdate.conf, you may
1018         want to remove the exclusion or change it to "always install".
1019         /etc/mail/sendmail.cf is now managed the same way regardless of
1020         whether SENDMAIL_MC/SENDMAIL_CF is used.  If you are not using
1021         SENDMAIL_MC/SENDMAIL_CF there should be no change in behavior.
1022
1023 20151011:
1024         Compatibility shims for legacy ATA device names have been removed.
1025         It includes ATA_STATIC_ID kernel option, kern.cam.ada.legacy_aliases
1026         and kern.geom.raid.legacy_aliases loader tunables, kern.devalias.*
1027         environment variables, /dev/ad* and /dev/ar* symbolic links.
1028
1029 20151006:
1030         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.7.0.
1031         Please see the 20141231 entry below for information about prerequisites
1032         and upgrading, if you are not already using clang 3.5.0 or higher.
1033
1034 20150924:
1035         Kernel debug files have been moved to /usr/lib/debug/boot/kernel/,
1036         and renamed from .symbols to .debug. This reduces the size requirements
1037         on the boot partition or file system and provides consistency with
1038         userland debug files.
1039
1040         When using the supported kernel installation method the
1041         /usr/lib/debug/boot/kernel directory will be renamed (to kernel.old)
1042         as is done with /boot/kernel.
1043
1044         Developers wishing to maintain the historical behavior of installing
1045         debug files in /boot/kernel/ can set KERN_DEBUGDIR="" in src.conf(5).
1046
1047 20150827:
1048         The wireless drivers had undergone changes that remove the 'parent
1049         interface' from the ifconfig -l output. The rc.d network scripts
1050         used to check presence of a parent interface in the list, so old
1051         scripts would fail to start wireless networking. Thus, etcupdate(3)
1052         or mergemaster(8) run is required after kernel update, to update your
1053         rc.d scripts in /etc.
1054
1055 20150827:
1056         pf no longer supports 'scrub fragment crop' or 'scrub fragment drop-ovl'
1057         These configurations are now automatically interpreted as
1058         'scrub fragment reassemble'.
1059
1060 20150817:
1061         Kernel-loadable modules for the random(4) device are back. To use
1062         them, the kernel must have
1063
1064         device  random
1065         options RANDOM_LOADABLE
1066
1067         kldload(8) can then be used to load random_fortuna.ko
1068         or random_yarrow.ko. Please note that due to the indirect
1069         function calls that the loadable modules need to provide,
1070         the build-in variants will be slightly more efficient.
1071
1072         The random(4) kernel option RANDOM_DUMMY has been retired due to
1073         unpopularity. It was not all that useful anyway.
1074
1075 20150813:
1076         The WITHOUT_ELFTOOLCHAIN_TOOLS src.conf(5) knob has been retired.
1077         Control over building the ELF Tool Chain tools is now provided by
1078         the WITHOUT_TOOLCHAIN knob.
1079
1080 20150810:
1081         The polarity of Pulse Per Second (PPS) capture events with the
1082         uart(4) driver has been corrected.  Prior to this change the PPS
1083         "assert" event corresponded to the trailing edge of a positive PPS
1084         pulse and the "clear" event was the leading edge of the next pulse.
1085
1086         As the width of a PPS pulse in a typical GPS receiver is on the
1087         order of 1 millisecond, most users will not notice any significant
1088         difference with this change.
1089
1090         Anyone who has compensated for the historical polarity reversal by
1091         configuring a negative offset equal to the pulse width will need to
1092         remove that workaround.
1093
1094 20150809:
1095         The default group assigned to /dev/dri entries has been changed
1096         from 'wheel' to 'video' with the id of '44'. If you want to have
1097         access to the dri devices please add yourself to the video group
1098         with:
1099
1100         # pw groupmod video -m $USER
1101
1102 20150806:
1103         The menu.rc and loader.rc files will now be replaced during
1104         upgrades. Please migrate local changes to menu.rc.local and
1105         loader.rc.local instead.
1106
1107 20150805:
1108         GNU Binutils versions of addr2line, c++filt, nm, readelf, size,
1109         strings and strip have been removed. The src.conf(5) knob
1110         WITHOUT_ELFTOOLCHAIN_TOOLS no longer provides the binutils tools.
1111
1112 20150728:
1113         As ZFS requires more kernel stack pages than is the default on some
1114         architectures e.g. i386, it now warns if KSTACK_PAGES is less than
1115         ZFS_MIN_KSTACK_PAGES (which is 4 at the time of writing).
1116
1117         Please consider using 'options KSTACK_PAGES=X' where X is greater
1118         than or equal to ZFS_MIN_KSTACK_PAGES i.e. 4 in such configurations.
1119
1120 20150706:
1121         sendmail has been updated to 8.15.2.  Starting with FreeBSD 11.0
1122         and sendmail 8.15, sendmail uses uncompressed IPv6 addresses by
1123         default, i.e., they will not contain "::".  For example, instead
1124         of ::1, it will be 0:0:0:0:0:0:0:1.  This permits a zero subnet
1125         to have a more specific match, such as different map entries for
1126         IPv6:0:0 vs IPv6:0.  This change requires that configuration
1127         data (including maps, files, classes, custom ruleset, etc.) must
1128         use the same format, so make certain such configuration data is
1129         upgrading.  As a very simple check search for patterns like
1130         'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'.  To return to the old
1131         behavior, set the m4 option confUSE_COMPRESSED_IPV6_ADDRESSES or
1132         the cf option UseCompressedIPv6Addresses.
1133
1134 20150630:
1135         The default kernel entropy-processing algorithm is now
1136         Fortuna, replacing Yarrow.
1137
1138         Assuming you have 'device random' in your kernel config
1139         file, the configurations allow a kernel option to override
1140         this default. You may choose *ONE* of:
1141
1142         options RANDOM_YARROW   # Legacy /dev/random algorithm.
1143         options RANDOM_DUMMY    # Blocking-only driver.
1144
1145         If you have neither, you get Fortuna.  For most people,
1146         read no further, Fortuna will give a /dev/random that works
1147         like it always used to, and the difference will be irrelevant.
1148
1149         If you remove 'device random', you get *NO* kernel-processed
1150         entropy at all. This may be acceptable to folks building
1151         embedded systems, but has complications. Carry on reading,
1152         and it is assumed you know what you need.
1153
1154         *PLEASE* read random(4) and random(9) if you are in the
1155         habit of tweaking kernel configs, and/or if you are a member
1156         of the embedded community, wanting specific and not-usual
1157         behaviour from your security subsystems.
1158
1159         NOTE!! If you use RANDOM_DUMMY and/or have no 'device
1160         random', you will NOT have a functioning /dev/random, and
1161         many cryptographic features will not work, including SSH.
1162         You may also find strange behaviour from the random(3) set
1163         of library functions, in particular sranddev(3), srandomdev(3)
1164         and arc4random(3). The reason for this is that the KERN_ARND
1165         sysctl only returns entropy if it thinks it has some to
1166         share, and with RANDOM_DUMMY or no 'device random' this
1167         will never happen.
1168
1169 20150623:
1170         An additional fix for the issue described in the 20150614 sendmail
1171         entry below has been committed in revision 284717.
1172
1173 20150616:
1174         FreeBSD's old make (fmake) has been removed from the system. It is
1175         available as the devel/fmake port or via pkg install fmake.
1176
1177 20150615:
1178         The fix for the issue described in the 20150614 sendmail entry
1179         below has been committed in revision 284436.  The work
1180         around described in that entry is no longer needed unless the
1181         default setting is overridden by a confDH_PARAMETERS configuration
1182         setting of '5' or pointing to a 512 bit DH parameter file.
1183
1184 20150614:
1185         ALLOW_DEPRECATED_ATF_TOOLS/ATFFILE support has been removed from
1186         atf.test.mk (included from bsd.test.mk). Please upgrade devel/atf
1187         and devel/kyua to version 0.20+ and adjust any calling code to work
1188         with Kyuafile and kyua.
1189
1190 20150614:
1191         The import of openssl to address the FreeBSD-SA-15:10.openssl
1192         security advisory includes a change which rejects handshakes
1193         with DH parameters below 768 bits.  sendmail releases prior
1194         to 8.15.2 (not yet released), defaulted to a 512 bit
1195         DH parameter setting for client connections.  To work around
1196         this interoperability, sendmail can be configured to use a
1197         2048 bit DH parameter by:
1198
1199         1. Edit /etc/mail/`hostname`.mc
1200         2. If a setting for confDH_PARAMETERS does not exist or
1201            exists and is set to a string beginning with '5',
1202            replace it with '2'.
1203         3. If a setting for confDH_PARAMETERS exists and is set to
1204            a file path, create a new file with:
1205                 openssl dhparam -out /path/to/file 2048
1206         4. Rebuild the .cf file:
1207                 cd /etc/mail/; make; make install
1208         5. Restart sendmail:
1209                 cd /etc/mail/; make restart
1210
1211         A sendmail patch is coming, at which time this file will be
1212         updated.
1213
1214 20150604:
1215         Generation of legacy formatted entries have been disabled by default
1216         in pwd_mkdb(8), as all base system consumers of the legacy formatted
1217         entries were converted to use the new format by default when the new,
1218         machine independent format have been added and supported since FreeBSD
1219         5.x.
1220
1221         Please see the pwd_mkdb(8) manual page for further details.
1222
1223 20150525:
1224         Clang and llvm have been upgraded to 3.6.1 release.  Please see the
1225         20141231 entry below for information about prerequisites and upgrading,
1226         if you are not already using 3.5.0 or higher.
1227
1228 20150521:
1229         TI platform code switched to using vendor DTS files and this update
1230         may break existing systems running on Beaglebone, Beaglebone Black,
1231         and Pandaboard:
1232
1233         - dtb files should be regenerated/reinstalled. Filenames are the
1234           same but content is different now
1235         - GPIO addressing was changed, now each GPIO bank (32 pins per bank)
1236           has its own /dev/gpiocX device, e.g. pin 121 on /dev/gpioc0 in old
1237           addressing scheme is now pin 25 on /dev/gpioc3.
1238         - Pandaboard: /etc/ttys should be updated, serial console device is
1239           now /dev/ttyu2, not /dev/ttyu0
1240
1241 20150501:
1242         soelim(1) from gnu/usr.bin/groff has been replaced by usr.bin/soelim.
1243         If you need the GNU extension from groff soelim(1), install groff
1244         from package: pkg install groff, or via ports: textproc/groff.
1245
1246 20150423:
1247         chmod, chflags, chown and chgrp now affect symlinks in -R mode as
1248         defined in symlink(7); previously symlinks were silently ignored.
1249
1250 20150415:
1251         The const qualifier has been removed from iconv(3) to comply with
1252         POSIX.  The ports tree is aware of this from r384038 onwards.
1253
1254 20150416:
1255         Libraries specified by LIBADD in Makefiles must have a corresponding
1256         DPADD_<lib> variable to ensure correct dependencies.  This is now
1257         enforced in src.libnames.mk.
1258
1259 20150324:
1260         From legacy ata(4) driver was removed support for SATA controllers
1261         supported by more functional drivers ahci(4), siis(4) and mvs(4).
1262         Kernel modules ataahci and ataadaptec were removed completely,
1263         replaced by ahci and mvs modules respectively.
1264
1265 20150315:
1266         Clang, llvm and lldb have been upgraded to 3.6.0 release.  Please see
1267         the 20141231 entry below for information about prerequisites and
1268         upgrading, if you are not already using 3.5.0 or higher.
1269
1270 20150307:
1271         The 32-bit PowerPC kernel has been changed to a position-independent
1272         executable. This can only be booted with a version of loader(8)
1273         newer than January 31, 2015, so make sure to update both world and
1274         kernel before rebooting.
1275
1276 20150217:
1277         If you are running a -CURRENT kernel since r273872 (Oct 30th, 2014),
1278         but before r278950, the RNG was not seeded properly.  Immediately
1279         upgrade the kernel to r278950 or later and regenerate any keys (e.g.
1280         ssh keys or openssl keys) that were generated w/ a kernel from that
1281         range.  This does not affect programs that directly used /dev/random
1282         or /dev/urandom.  All userland uses of arc4random(3) are affected.
1283
1284 20150210:
1285         The autofs(4) ABI was changed in order to restore binary compatibility
1286         with 10.1-RELEASE.  The automountd(8) daemon needs to be rebuilt to work
1287         with the new kernel.
1288
1289 20150131:
1290         The powerpc64 kernel has been changed to a position-independent
1291         executable. This can only be booted with a new version of loader(8),
1292         so make sure to update both world and kernel before rebooting.
1293
1294 20150118:
1295         Clang and llvm have been upgraded to 3.5.1 release.  This is a bugfix
1296         only release, no new features have been added.  Please see the 20141231
1297         entry below for information about prerequisites and upgrading, if you
1298         are not already using 3.5.0.
1299
1300 20150107:
1301         ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
1302         taken from the ELF Tool Chain project rather than GNU binutils. They
1303         should be drop-in replacements, with the addition of arm64 support.
1304         The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
1305         binutils tools, if necessary. See 20150805 for updated information.
1306
1307 20150105:
1308         The default Unbound configuration now enables remote control
1309         using a local socket.  Users who have already enabled the
1310         local_unbound service should regenerate their configuration
1311         by running "service local_unbound setup" as root.
1312
1313 20150102:
1314         The GNU texinfo and GNU info pages have been removed.
1315         To be able to view GNU info pages please install texinfo from ports.
1316
1317 20141231:
1318         Clang, llvm and lldb have been upgraded to 3.5.0 release.
1319
1320         As of this release, a prerequisite for building clang, llvm and lldb is
1321         a C++11 capable compiler and C++11 standard library.  This means that to
1322         be able to successfully build the cross-tools stage of buildworld, with
1323         clang as the bootstrap compiler, your system compiler or cross compiler
1324         should either be clang 3.3 or later, or gcc 4.8 or later, and your
1325         system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
1326         later.
1327
1328         On any standard FreeBSD 10.x or 11.x installation, where clang and
1329         libc++ are on by default (that is, on x86 or arm), this should work out
1330         of the box.
1331
1332         On 9.x installations where clang is enabled by default, e.g. on x86 and
1333         powerpc, libc++ will not be enabled by default, so libc++ should be
1334         built (with clang) and installed first.  If both clang and libc++ are
1335         missing, build clang first, then use it to build libc++.
1336
1337         On 8.x and earlier installations, upgrade to 9.x first, and then follow
1338         the instructions for 9.x above.
1339
1340         Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
1341         default, and do not build clang.
1342
1343         Many embedded systems are resource constrained, and will not be able to
1344         build clang in a reasonable time, or in some cases at all.  In those
1345         cases, cross building bootable systems on amd64 is a workaround.
1346
1347         This new version of clang introduces a number of new warnings, of which
1348         the following are most likely to appear:
1349
1350         -Wabsolute-value
1351
1352         This warns in two cases, for both C and C++:
1353         * When the code is trying to take the absolute value of an unsigned
1354           quantity, which is effectively a no-op, and almost never what was
1355           intended.  The code should be fixed, if at all possible.  If you are
1356           sure that the unsigned quantity can be safely cast to signed, without
1357           loss of information or undefined behavior, you can add an explicit
1358           cast, or disable the warning.
1359
1360         * When the code is trying to take an absolute value, but the called
1361           abs() variant is for the wrong type, which can lead to truncation.
1362           If you want to disable the warning instead of fixing the code, please
1363           make sure that truncation will not occur, or it might lead to unwanted
1364           side-effects.
1365
1366         -Wtautological-undefined-compare and
1367         -Wundefined-bool-conversion
1368
1369         These warn when C++ code is trying to compare 'this' against NULL, while
1370         'this' should never be NULL in well-defined C++ code.  However, there is
1371         some legacy (pre C++11) code out there, which actively abuses this
1372         feature, which was less strictly defined in previous C++ versions.
1373
1374         Squid and openjdk do this, for example.  The warning can be turned off
1375         for C++98 and earlier, but compiling the code in C++11 mode might result
1376         in unexpected behavior; for example, the parts of the program that are
1377         unreachable could be optimized away.
1378
1379 20141222:
1380         The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
1381         kernel sources have been removed. The .h files remain, since some
1382         utilities include them. This will need to be fixed later.
1383         If "mount -t oldnfs ..." is attempted, it will fail.
1384         If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
1385         the utilities will report errors.
1386
1387 20141121:
1388         The handling of LOCAL_LIB_DIRS has been altered to skip addition of
1389         directories to top level SUBDIR variable when their parent
1390         directory is included in LOCAL_DIRS.  Users with build systems with
1391         such hierarchies and without SUBDIR entries in the parent
1392         directory Makefiles should add them or add the directories to
1393         LOCAL_DIRS.
1394
1395 20141109:
1396         faith(4) and faithd(8) have been removed from the base system. Faith
1397         has been obsolete for a very long time.
1398
1399 20141104:
1400         vt(4), the new console driver, is enabled by default. It brings
1401         support for Unicode and double-width characters, as well as
1402         support for UEFI and integration with the KMS kernel video
1403         drivers.
1404
1405         You may need to update your console settings in /etc/rc.conf,
1406         most probably the keymap. During boot, /etc/rc.d/syscons will
1407         indicate what you need to do.
1408
1409         vt(4) still has issues and lacks some features compared to
1410         syscons(4). See the wiki for up-to-date information:
1411           https://wiki.freebsd.org/Newcons
1412
1413         If you want to keep using syscons(4), you can do so by adding
1414         the following line to /boot/loader.conf:
1415           kern.vty=sc
1416
1417 20141102:
1418         pjdfstest has been integrated into kyua as an opt-in test suite.
1419         Please see share/doc/pjdfstest/README for more details on how to
1420         execute it.
1421
1422 20141009:
1423         gperf has been removed from the base system for architectures
1424         that use clang. Ports that require gperf will obtain it from the
1425         devel/gperf port.
1426
1427 20140923:
1428         pjdfstest has been moved from tools/regression/pjdfstest to
1429         contrib/pjdfstest .
1430
1431 20140922:
1432         At svn r271982, The default linux compat kernel ABI has been adjusted
1433         to 2.6.18 in support of the linux-c6 compat ports infrastructure
1434         update.  If you wish to continue using the linux-f10 compat ports,
1435         add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
1436         encouraged to update their linux-compat packages to linux-c6 during
1437         their next update cycle.
1438
1439 20140729:
1440         The ofwfb driver, used to provide a graphics console on PowerPC when
1441         using vt(4), no longer allows mmap() of all physical memory. This
1442         will prevent Xorg on PowerPC with some ATI graphics cards from
1443         initializing properly unless x11-servers/xorg-server is updated to
1444         1.12.4_8 or newer.
1445
1446 20140723:
1447         The xdev targets have been converted to using TARGET and
1448         TARGET_ARCH instead of XDEV and XDEV_ARCH.
1449
1450 20140719:
1451         The default unbound configuration has been modified to address
1452         issues with reverse lookups on networks that use private
1453         address ranges.  If you use the local_unbound service, run
1454         "service local_unbound setup" as root to regenerate your
1455         configuration, then "service local_unbound reload" to load the
1456         new configuration.
1457
1458 20140709:
1459         The GNU texinfo and GNU info pages are not built and installed
1460         anymore, WITH_INFO knob has been added to allow to built and install
1461         them again.
1462         UPDATE: see 20150102 entry on texinfo's removal
1463
1464 20140708:
1465         The GNU readline library is now an INTERNALLIB - that is, it is
1466         statically linked into consumers (GDB and variants) in the base
1467         system, and the shared library is no longer installed.  The
1468         devel/readline port is available for third party software that
1469         requires readline.
1470
1471 20140702:
1472         The Itanium architecture (ia64) has been removed from the list of
1473         known architectures. This is the first step in the removal of the
1474         architecture.
1475
1476 20140701:
1477         Commit r268115 has added NFSv4.1 server support, merged from
1478         projects/nfsv4.1-server.  Since this includes changes to the
1479         internal interfaces between the NFS related modules, a full
1480         build of the kernel and modules will be necessary.
1481         __FreeBSD_version has been bumped.
1482
1483 20140629:
1484         The WITHOUT_VT_SUPPORT kernel config knob has been renamed
1485         WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
1486         which differs from the behaviour controlled by this knob.)
1487
1488 20140619:
1489         Maximal length of the serial number in CTL was increased from 16 to
1490         64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
1491         and ctld, need to be rebuilt to work with a new kernel.
1492
1493 20140606:
1494         The libatf-c and libatf-c++ major versions were downgraded to 0 and
1495         1 respectively to match the upstream numbers.  They were out of
1496         sync because, when they were originally added to FreeBSD, the
1497         upstream versions were not respected.  These libraries are private
1498         and not yet built by default, so renumbering them should be a
1499         non-issue.  However, unclean source trees will yield broken test
1500         programs once the operator executes "make delete-old-libs" after a
1501         "make installworld".
1502
1503         Additionally, the atf-sh binary was made private by moving it into
1504         /usr/libexec/.  Already-built shell test programs will keep the
1505         path to the old binary so they will break after "make delete-old"
1506         is run.
1507
1508         If you are using WITH_TESTS=yes (not the default), wipe the object
1509         tree and rebuild from scratch to prevent spurious test failures.
1510         This is only needed once: the misnumbered libraries and misplaced
1511         binaries have been added to OptionalObsoleteFiles.inc so they will
1512         be removed during a clean upgrade.
1513
1514 20140512:
1515         Clang and llvm have been upgraded to 3.4.1 release.
1516
1517 20140508:
1518         We bogusly installed src.opts.mk in /usr/share/mk. This file should
1519         be removed to avoid issues in the future (and has been added to
1520         ObsoleteFiles.inc).
1521
1522 20140505:
1523         /etc/src.conf now affects only builds of the FreeBSD src tree. In the
1524         past, it affected all builds that used the bsd.*.mk files. The old
1525         behavior was a bug, but people may have relied upon it. To get this
1526         behavior back, you can .include /etc/src.conf from /etc/make.conf
1527         (which is still global and isn't changed). This also changes the
1528         behavior of incremental builds inside the tree of individual
1529         directories. Set MAKESYSPATH to ".../share/mk" to do that.
1530         Although this has survived make universe and some upgrade scenarios,
1531         other upgrade scenarios may have broken. At least one form of
1532         temporary breakage was fixed with MAKESYSPATH settings for buildworld
1533         as well... In cases where MAKESYSPATH isn't working with this
1534         setting, you'll need to set it to the full path to your tree.
1535
1536         One side effect of all this cleaning up is that bsd.compiler.mk
1537         is no longer implicitly included by bsd.own.mk. If you wish to
1538         use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
1539         as well.
1540
1541 20140430:
1542         The lindev device has been removed since /dev/full has been made a
1543         standard device.  __FreeBSD_version has been bumped.
1544
1545 20140424:
1546         The knob WITHOUT_VI was added to the base system, which controls
1547         building ex(1), vi(1), etc. Older releases of FreeBSD required ex(1)
1548         in order to reorder files share/termcap and didn't build ex(1) as a
1549         build tool, so building/installing with WITH_VI is highly advised for
1550         build hosts for older releases.
1551
1552         This issue has been fixed in stable/9 and stable/10 in r277022 and
1553         r276991, respectively.
1554
1555 20140418:
1556         The YES_HESIOD knob has been removed. It has been obsolete for
1557         a decade. Please move to using WITH_HESIOD instead or your builds
1558         will silently lack HESIOD.
1559
1560 20140405:
1561         The uart(4) driver has been changed with respect to its handling
1562         of the low-level console. Previously the uart(4) driver prevented
1563         any process from changing the baudrate or the CLOCAL and HUPCL
1564         control flags. By removing the restrictions, operators can make
1565         changes to the serial console port without having to reboot.
1566         However, when getty(8) is started on the serial device that is
1567         associated with the low-level console, a misconfigured terminal
1568         line in /etc/ttys will now have a real impact.
1569         Before upgrading the kernel, make sure that /etc/ttys has the
1570         serial console device configured as 3wire without baudrate to
1571         preserve the previous behaviour. E.g:
1572             ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
1573
1574 20140306:
1575         Support for libwrap (TCP wrappers) in rpcbind was disabled by default
1576         to improve performance.  To re-enable it, if needed, run rpcbind
1577         with command line option -W.
1578
1579 20140226:
1580         Switched back to the GPL dtc compiler due to updates in the upstream
1581         dts files not being supported by the BSDL dtc compiler. You will need
1582         to rebuild your kernel toolchain to pick up the new compiler. Core dumps
1583         may result while building dtb files during a kernel build if you fail
1584         to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
1585
1586 20140216:
1587         Clang and llvm have been upgraded to 3.4 release.
1588
1589 20140216:
1590         The nve(4) driver has been removed.  Please use the nfe(4) driver
1591         for NVIDIA nForce MCP Ethernet adapters instead.
1592
1593 20140212:
1594         An ABI incompatibility crept into the libc++ 3.4 import in r261283.
1595         This could cause certain C++ applications using shared libraries built
1596         against the previous version of libc++ to crash.  The incompatibility
1597         has now been fixed, but any C++ applications or shared libraries built
1598         between r261283 and r261801 should be recompiled.
1599
1600 20140204:
1601         OpenSSH will now ignore errors caused by kernel lacking of Capsicum
1602         capability mode support.  Please note that enabling the feature in
1603         kernel is still highly recommended.
1604
1605 20140131:
1606         OpenSSH is now built with sandbox support, and will use sandbox as
1607         the default privilege separation method.  This requires Capsicum
1608         capability mode support in kernel.
1609
1610 20140128:
1611         The libelf and libdwarf libraries have been updated to newer
1612         versions from upstream. Shared library version numbers for
1613         these two libraries were bumped. Any ports or binaries
1614         requiring these two libraries should be recompiled.
1615         __FreeBSD_version is bumped to 1100006.
1616
1617 20140110:
1618         If a Makefile in a tests/ directory was auto-generating a Kyuafile
1619         instead of providing an explicit one, this would prevent such
1620         Makefile from providing its own Kyuafile in the future during
1621         NO_CLEAN builds.  This has been fixed in the Makefiles but manual
1622         intervention is needed to clean an objdir if you use NO_CLEAN:
1623           # find /usr/obj -name Kyuafile | xargs rm -f
1624
1625 20131213:
1626         The behavior of gss_pseudo_random() for the krb5 mechanism
1627         has changed, for applications requesting a longer random string
1628         than produced by the underlying enctype's pseudo-random() function.
1629         In particular, the random string produced from a session key of
1630         enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
1631         be different at the 17th octet and later, after this change.
1632         The counter used in the PRF+ construction is now encoded as a
1633         big-endian integer in accordance with RFC 4402.
1634         __FreeBSD_version is bumped to 1100004.
1635
1636 20131108:
1637         The WITHOUT_ATF build knob has been removed and its functionality
1638         has been subsumed into the more generic WITHOUT_TESTS.  If you were
1639         using the former to disable the build of the ATF libraries, you
1640         should change your settings to use the latter.
1641
1642 20131025:
1643         The default version of mtree is nmtree which is obtained from
1644         NetBSD.  The output is generally the same, but may vary
1645         slightly.  If you found you need identical output adding
1646         "-F freebsd9" to the command line should do the trick.  For the
1647         time being, the old mtree is available as fmtree.
1648
1649 20131014:
1650         libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
1651         This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
1652         1.1.4_8 and verify bsdyml not linked in, before running "make
1653         delete-old-libs":
1654           # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
1655           or
1656           # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
1657
1658 20131010:
1659         The stable/10 branch has been created in subversion from head
1660         revision r256279.
1661
1662 COMMON ITEMS:
1663
1664         General Notes
1665         -------------
1666         Avoid using make -j when upgrading.  While generally safe, there are
1667         sometimes problems using -j to upgrade.  If your upgrade fails with
1668         -j, please try again without -j.  From time to time in the past there
1669         have been problems using -j with buildworld and/or installworld.  This
1670         is especially true when upgrading between "distant" versions (eg one
1671         that cross a major release boundary or several minor releases, or when
1672         several months have passed on the -current branch).
1673
1674         Sometimes, obscure build problems are the result of environment
1675         poisoning.  This can happen because the make utility reads its
1676         environment when searching for values for global variables.  To run
1677         your build attempts in an "environmental clean room", prefix all make
1678         commands with 'env -i '.  See the env(1) manual page for more details.
1679
1680         When upgrading from one major version to another it is generally best to
1681         upgrade to the latest code in the currently installed branch first, then
1682         do an upgrade to the new branch. This is the best-tested upgrade path,
1683         and has the highest probability of being successful.  Please try this
1684         approach if you encounter problems with a major version upgrade.  Since
1685         the stable 4.x branch point, one has generally been able to upgrade from
1686         anywhere in the most recent stable branch to head / current (or even the
1687         last couple of stable branches). See the top of this file when there's
1688         an exception.
1689
1690         When upgrading a live system, having a root shell around before
1691         installing anything can help undo problems. Not having a root shell
1692         around can lead to problems if pam has changed too much from your
1693         starting point to allow continued authentication after the upgrade.
1694
1695         This file should be read as a log of events. When a later event changes
1696         information of a prior event, the prior event should not be deleted.
1697         Instead, a pointer to the entry with the new information should be
1698         placed in the old entry. Readers of this file should also sanity check
1699         older entries before relying on them blindly. Authors of new entries
1700         should write them with this in mind.
1701
1702         ZFS notes
1703         ---------
1704         When upgrading the boot ZFS pool to a new version, always follow
1705         these two steps:
1706
1707         1.) recompile and reinstall the ZFS boot loader and boot block
1708         (this is part of "make buildworld" and "make installworld")
1709
1710         2.) update the ZFS boot block on your boot drive
1711
1712         The following example updates the ZFS boot block on the first
1713         partition (freebsd-boot) of a GPT partitioned drive ada0:
1714         "gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
1715
1716         Non-boot pools do not need these updates.
1717
1718         To build a kernel
1719         -----------------
1720         If you are updating from a prior version of FreeBSD (even one just
1721         a few days old), you should follow this procedure.  It is the most
1722         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1723
1724         make kernel-toolchain
1725         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1726         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1727
1728         To test a kernel once
1729         ---------------------
1730         If you just want to boot a kernel once (because you are not sure
1731         if it works, or if you want to boot a known bad kernel to provide
1732         debugging information) run
1733         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1734         nextboot -k testkernel
1735
1736         To rebuild everything and install it on the current system.
1737         -----------------------------------------------------------
1738         # Note: sometimes if you are running current you gotta do more than
1739         # is listed here if you are upgrading from a really old current.
1740
1741         <make sure you have good level 0 dumps>
1742         make buildworld
1743         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1744         make installkernel KERNCONF=YOUR_KERNEL_HERE
1745                                                         [1]
1746         <reboot in single user>                         [3]
1747         mergemaster -Fp                                 [5]
1748         make installworld
1749         mergemaster -Fi                                 [4]
1750         make delete-old                                 [6]
1751         <reboot>
1752
1753         To cross-install current onto a separate partition
1754         --------------------------------------------------
1755         # In this approach we use a separate partition to hold
1756         # current's root, 'usr', and 'var' directories.   A partition
1757         # holding "/", "/usr" and "/var" should be about 2GB in
1758         # size.
1759
1760         <make sure you have good level 0 dumps>
1761         <boot into -stable>
1762         make buildworld
1763         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1764         <maybe newfs current's root partition>
1765         <mount current's root partition on directory ${CURRENT_ROOT}>
1766         make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
1767         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1768         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1769         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
1770         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1771         <reboot into current>
1772         <do a "native" rebuild/install as described in the previous section>
1773         <maybe install compatibility libraries from ports/misc/compat*>
1774         <reboot>
1775
1776
1777         To upgrade in-place from stable to current
1778         ----------------------------------------------
1779         <make sure you have good level 0 dumps>
1780         make buildworld                                 [9]
1781         make buildkernel KERNCONF=YOUR_KERNEL_HERE      [8]
1782         make installkernel KERNCONF=YOUR_KERNEL_HERE
1783                                                         [1]
1784         <reboot in single user>                         [3]
1785         mergemaster -Fp                                 [5]
1786         make installworld
1787         mergemaster -Fi                                 [4]
1788         make delete-old                                 [6]
1789         <reboot>
1790
1791         Make sure that you've read the UPDATING file to understand the
1792         tweaks to various things you need.  At this point in the life
1793         cycle of current, things change often and you are on your own
1794         to cope.  The defaults can also change, so please read ALL of
1795         the UPDATING entries.
1796
1797         Also, if you are tracking -current, you must be subscribed to
1798         freebsd-current@freebsd.org.  Make sure that before you update
1799         your sources that you have read and understood all the recent
1800         messages there.  If in doubt, please track -stable which has
1801         much fewer pitfalls.
1802
1803         [1] If you have third party modules, such as vmware, you
1804         should disable them at this point so they don't crash your
1805         system on reboot.
1806
1807         [3] From the bootblocks, boot -s, and then do
1808                 fsck -p
1809                 mount -u /
1810                 mount -a
1811                 cd src
1812                 adjkerntz -i            # if CMOS is wall time
1813         Also, when doing a major release upgrade, it is required that
1814         you boot into single user mode to do the installworld.
1815
1816         [4] Note: This step is non-optional.  Failure to do this step
1817         can result in a significant reduction in the functionality of the
1818         system.  Attempting to do it by hand is not recommended and those
1819         that pursue this avenue should read this file carefully, as well
1820         as the archives of freebsd-current and freebsd-hackers mailing lists
1821         for potential gotchas.  The -U option is also useful to consider.
1822         See mergemaster(8) for more information.
1823
1824         [5] Usually this step is a no-op.  However, from time to time
1825         you may need to do this if you get unknown user in the following
1826         step.  It never hurts to do it all the time.  You may need to
1827         install a new mergemaster (cd src/usr.sbin/mergemaster && make
1828         install) after the buildworld before this step if you last updated
1829         from current before 20130425 or from -stable before 20130430.
1830
1831         [6] This only deletes old files and directories. Old libraries
1832         can be deleted by "make delete-old-libs", but you have to make
1833         sure that no program is using those libraries anymore.
1834
1835         [8] In order to have a kernel that can run the 4.x binaries needed to
1836         do an installworld, you must include the COMPAT_FREEBSD4 option in
1837         your kernel.  Failure to do so may leave you with a system that is
1838         hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1839         required to run the 5.x binaries on more recent kernels.  And so on
1840         for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1841
1842         Make sure that you merge any new devices from GENERIC since the
1843         last time you updated your kernel config file.
1844
1845         [9] If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1846         "?=" instead of the "=" assignment operator, so that buildworld can
1847         override the CPUTYPE if it needs to.
1848
1849         MAKEOBJDIRPREFIX must be defined in an environment variable, and
1850         not on the command line, or in /etc/make.conf.  buildworld will
1851         warn if it is improperly defined.
1852 FORMAT:
1853
1854 This file contains a list, in reverse chronological order, of major
1855 breakages in tracking -current.  It is not guaranteed to be a complete
1856 list of such breakages, and only contains entries since September 23, 2011.
1857 If you need to see UPDATING entries from before that date, you will need
1858 to fetch an UPDATING file from an older FreeBSD release.
1859
1860 Copyright information:
1861
1862 Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1863
1864 Redistribution, publication, translation and use, with or without
1865 modification, in full or in part, in any form or format of this
1866 document are permitted without further permission from the author.
1867
1868 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1869 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1870 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1871 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1872 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1873 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1874 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1875 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1876 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1877 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1878 POSSIBILITY OF SUCH DAMAGE.
1879
1880 Contact Warner Losh if you have any questions about your use of
1881 this document.
1882
1883 $FreeBSD$