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