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