]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - UPDATING
byacc: Update to 20230201.
[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://docs.freebsd.org/en/books/handbook/cutting-edge/#makeworld
10
11 Items affecting the ports and packages system can be found in
12 /usr/ports/UPDATING.  Please read that file before updating system packages
13 and/or ports.
14
15 NOTE TO PEOPLE WHO THINK THAT FreeBSD 14.x IS SLOW:
16         FreeBSD 14.x has many debugging features turned on, in both the kernel
17         and userland.  These features attempt to detect incorrect use of
18         system primitives, and encourage loud failure through extra sanity
19         checking and fail stop semantics.  They also substantially impact
20         system performance.  If you want to do performance measurement,
21         benchmarking, and optimization, you'll want to turn them off.  This
22         includes various WITNESS- related kernel options, INVARIANTS, malloc
23         debugging flags in userland, and various verbose features in the
24         kernel.  Many developers choose to disable these features on build
25         machines to maximize performance.  (To completely disable malloc
26         debugging, define WITH_MALLOC_PRODUCTION in /etc/src.conf and rebuild
27         world, or to merely disable the most expensive debugging functionality
28         at runtime, run "ln -s 'abort:false,junk:false' /etc/malloc.conf".)
29
30 20230206:
31         sshd now defaults to having X11Forwarding disabled, following upstream.
32         Administrators who wish to enable X11Forwarding should add
33         `X11Forwarding yes` to /etc/ssh/sshd_config.
34
35 20230204:
36         Since commit 75d41cb6967 Huawei 3G/4G LTE Mobile Devices do not default
37         to ECM, but NCM mode and need u3g and ucom modules loaded. See cdce(4).
38
39 20230130:
40         As of commit 7c40e2d5f685, the dependency on netlink(4) has been added
41         to the linux_common(4) module. Users relying on linux_common may need
42         to complile netlink(4) module if it is not present in their kernel.
43
44 20230126:
45         The WITHOUT_CXX option has been removed. C++ components in the base
46         system are now built unconditionally.
47
48 20230113:
49         LinuxKPI pci.h changes may require out-of-tree drivers to be recompiled.
50         Bump _FreeBSD_version to 1400078 to be able to detect this change.
51
52 20221212:
53         llvm-objump is now always installed as objdump.  Previously there was
54         no /usr/bin/objdump unless the WITH_LLVM_BINUTILS knob was used.
55
56         Some LLVM objdump options have a different output format compared to
57         GNU objdump; readelf is available for inspecting ELF files, and GNU
58         objdump is available from the devel/binutils port or package.
59
60 20221205:
61         dma(8) has replaced sendmail(8) as the default mta.  For people willing
62         to reenable sendmail(8):
63
64         $ cp /usr/share/examples/sendmail/mailer.conf /etc/mail/mailer.conf
65
66         and add sendmail_enable="YES" to rc.conf.
67
68 20221204:
69         hw.bus.disable_failed_devices has changed from 'false' to 'true' by
70         default. Now if newbus succeeds in probing a device, but fails to attach
71         the device, we'll disable the device. In the past, we'd keep retrying
72         the device on each new driver loaded. To get that behavior now, one
73         needs to use devctl to re-enable the device, and reprobe it (or set
74         the sysctl/tunable hw.bus.disable_failed_devices=false).
75
76         NOTE: This was reverted 20221205 due to unexpected compatibility issues
77
78 20221122:
79         pf no longer accepts 'scrub fragment crop' or 'scrub fragment drop-ovl'.
80         These configurations are no longer automatically reinterpreted as
81         'scrub fragment reassemble'.
82
83 20221121:
84         The WITHOUT_CLANG_IS_CC option has been removed.  When Clang is enabled
85         it is always installed as /usr/bin/cc (and c++, cpp).
86
87 20221026:
88         Some programs have been moved into separate packages. It is recommended
89         for pkgbase users to do:
90
91         pkg install FreeBSD-dhclient FreeBSD-geom FreeBSD-resolvconf \
92           FreeBSD-devd FreeBSD-devmatch
93
94         after upgrading to restore all the component that were previously
95         installed.
96
97 20220610:
98         LinuxKPI pm.h changes require an update to the latest drm-kmod version
99         before re-compiling to avoid errors.
100
101 20211230:
102         The macros provided for the manipulation of CPU sets (e.g. CPU_AND)
103         have been modified to take 2 source arguments instead of only 1.
104         Externally maintained sources that use these macros will have to
105         be adapted. The FreeBSD version has been bumped to 1400046 to
106         reflect this change.
107
108 20211214:
109         A number of the kernel include files are able to be included by
110         themselves.  A test has been added to buildworld to enforce this.
111
112 20211209:
113         Remove mips as a recognized target. This starts the decommissioning of
114         mips support in FreeBSD. mips related items will be removed wholesale in
115         the coming days and weeks.
116
117         This broke the NO_CLEAN build for some people. Either do a clean build
118         or touch
119                 lib/clang/include/llvm/Config/Targets.def
120                 lib/clang/include/llvm/Config/AsmParsers.def
121                 lib/clang/include/llvm/Config/Disassemblers.def
122                 lib/clang/include/llvm/Config/AsmPrinters.def
123         before the build to force everything to rebuild that needs to.
124
125 20211202:
126         Unbound support for RFC8375: The special-use domain 'home.arpa' is
127         by default blocked. To unblock it use a local-zone nodefault
128         statement in unbound.conf:
129                 local-zone: "home.arpa." nodefault
130
131         Or use another type of local-zone to override with your choice.
132
133         The reason for this is discussed in Section 6.1 of RFC8375:
134         Because 'home.arpa.' is not globally scoped and cannot be secured
135         using DNSSEC based on the root domain's trust anchor, there is no way
136         to tell, using a standard DNS query, in which homenet scope an answer
137         belongs.  Consequently, users may experience surprising results with
138         such names when roaming to different homenets.
139
140 20211110:
141         Commit b8d60729deef changed the TCP congestion control framework so
142         that any of the included congestion control modules could be
143         the single module built into the kernel. Previously newreno
144         was automatically built in through direct reference. As of
145         this commit you are required to declare at least one congestion
146         control module (e.g. 'options CC_NEWRENO') and to also declare a
147         default using the CC_DEFAULT option (e.g. options CC_DEFAULT="newreno\").
148         The GENERIC configuration includes CC_NEWRENO and defines newreno
149         as the default. If no congestion control option is built into the
150         kernel and you are including networking, the kernel compile will
151         fail. Also if no default is declared the kernel compile will fail.
152
153 20211118:
154         Mips has been removed from universe builds. It will be removed from the
155         tree shortly.
156
157 20211106:
158         Commit f0c9847a6c47 changed the arguments for VOP_ALLOCATE.
159         The NFS modules must be rebuilt from sources and any out
160         of tree file systems that implement their own VOP_ALLOCATE
161         may need to be modified.
162
163 20211022:
164         The synchronous PPP kernel driver sppp(4) has been removed.
165         The cp(4) and ce(4) drivers are now always compiled with netgraph(4)
166         support, formerly enabled by NETGRAPH_CRONYX option.
167
168 20211020:
169         sh(1) is now the default shell for the root user.  To force root to use
170         the csh shell, please run the following command as root:
171
172         # chsh -s csh
173
174 20211004:
175         Ncurses distribution has been split between libtinfow and libncurses
176         with libncurses.so becoming a linker (ld) script to seamlessly link
177         to libtinfow as needed. Bump _FreeBSD_version to 1400035 to reflect
178         this change.
179
180 20210923:
181         As of commit 8160a0f62be6, the dummynet module no longer depends on the
182         ipfw module. Dummynet can now be used by pf as well as ipfw. As such
183         users who relied on this dependency may need to include ipfw in the
184         list of modules to load on their systems.
185
186 20210922:
187         As of commit 903873ce1560, the mixer(8) utility has got a slightly
188         new syntax. Please refer to the mixer(8) manual page for more
189         information. The old mixer utility can be installed from ports:
190         audio/freebsd-13-mixer
191
192 20210911:
193         As of commit 55089ef4f8bb, the global variable nfs_maxcopyrange has
194         been deleted from the nfscommon.ko.  As such, nfsd.ko must be built
195         from up to date sources to avoid an undefined reference when
196         being loaded.
197
198 20210817:
199         As of commit 62ca9fc1ad56 OpenSSL no longer enables kernel TLS
200         by default.  Users can enable kernel TLS via the "KTLS" SSL
201         option.  This can be enabled globally by using a custom
202         OpenSSL config file via OPENSSL_CONF or via an
203         application-specific configuration option for applications
204         which permit setting SSL options via SSL_CONF_cmd(3).
205
206 20210811:
207         Commit 3ad1e1c1ce20 changed the internal KAPI between the NFS
208         modules. Therefore, all need to be rebuilt from sources.
209
210 20210730:
211         Commit b69019c14cd8 removes pf's DIOCGETSTATESNV ioctl.
212         As of be70c7a50d32 it is no longer used by userspace, but it does mean
213         users may not be able to enumerate pf states if they update the kernel
214         past b69019c14cd8 without first updating userspace past be70c7a50d32.
215
216 20210729:
217         As of commit 01ad0c007964 if_bridge member interfaces can no longer
218         change their MTU. Changing the MTU of the bridge itself will change the
219         MTU on all member interfaces instead.
220
221 20210716:
222         Commit ee29e6f31111 changed the internal KAPI between the nfscommon
223         and nfsd modules. Therefore, both need to be rebuilt from sources.
224         Bump __FreeBSD_version to 1400026 for this KAPI change.
225
226 20210715:
227         The 20210707 awk update brought in a change in behavior. This has
228         been corrected as of d4d252c49976. Between these dates, if you
229         installed a new awk binary, you may not be able to build a new
230         kernel because the change in behavior affected the genoffset
231         script used to build the kernel. If you did update, the fix is
232         to update your sources past the above hash and do
233                 % cd usr.bin/awk
234                 % make clean all
235                 % sudo -E make install
236         to enable building kernels again.
237
238 20210708:
239         Commit 1e0a518d6548 changed the internal KAPI between the NFS
240         modules. They all need to be rebuilt from sources.  I did not
241         bump __FreeBSD_version, since it was bumped recently.
242
243 20210707:
244         awk has been updated to the latest one-true-awk version 20210215.
245         This contains a number of minor bug fixes.
246
247 20210624:
248         The NFSv4 client now uses the highest minor version of NFSv4
249         supported by the NFSv4 server by default instead of minor version 0,
250         for NFSv4 mounts.
251         The "minorversion" mount option may be used to override this default.
252
253 20210618:
254         Bump __FreeBSD_version to 1400024 for LinuxKPI changes.
255         Most notably netdev.h can change now as the (last) dependencies
256         (mlx4/ofed) are now using struct ifnet directly, but also for PCI
257         additions and others.
258
259 20210618:
260         The directory "blacklisted" under /usr/share/certs/ has been
261         renamed to "untrusted".
262
263 20210611:
264         svnlite has been removed from base. Should you need svn for any reason
265         please install the svn package or port.
266
267 20210611:
268         Commit e1a907a25cfa changed the internal KAPI between the krpc
269         and nfsserver.  As such, both modules must be rebuilt from
270         sources.  Bump __FreeBSD_version to 1400022.
271
272 20210610:
273         The an(4) driver has been removed from FreeBSD.
274
275 20210608:
276         The vendor/openzfs branch was renamed to vendor/openzfs/legacy to
277         start tracking OpenZFS upstream more closely. Please see
278 https://lists.freebsd.org/archives/freebsd-current/2021-June/000153.html
279         for details on how to correct any errors that might result. The
280         short version is that you need to remove the old branch locally:
281             git update-ref -d refs/remotes/freebsd/vendor/openzfs
282         (assuming your upstream origin is named 'freebsd').
283
284 20210525:
285         Commits 17accc08ae15 and de102f870501 add new files to LinuxKPI
286         which break drm-kmod.  In addition various other additions where
287         committed. Bump __FreeBSD_version to 1400015 to be able to
288         detect this.
289
290 20210513:
291         Commit ca179c4d74f2 changed the package in which the OpenSSL
292         libraries and utilities are packaged.
293         It is recommended for pkgbase user to do:
294         pkg install -f FreeBSD-openssl
295         before pkg upgrade otherwise some dependencies might not be met
296         and pkg will stop working as libssl will not be present anymore
297         on the system.
298
299 20210426:
300         Commit 875977314881 changed the internal KAPI between
301         the nfsd and nfscommon modules.  As such these modules
302         need to be rebuilt from sources.
303         Without this patch in your NFSv4.1/4.2 server, enabling
304         delegations by setting vfs.nfsd.issue_delegations non-zero
305         is not recommended.
306
307 20210411:
308         Commit 7763814fc9c2 changed the internal KAPI between
309         the krpc and NFS.  As such, the krpc, nfscommon and
310         nfscl modules must all be rebuilt from sources.
311         Without this patch, NFSv4.1/4.2 mounts should not
312         be done with the nfscbd(8) daemon running, to avoid
313         needing a working back channel for server->client RPCs.
314
315 20210330:
316         Commit 01ae8969a9ee fixed the NFSv4.1/4.2 server so that it
317         handles binding of the back channel as required by RFC5661.
318         Until this patch is in your server, avoid use of the "nconnects"
319         mount option for Linux NFSv4.1/4.2 mounts.
320
321 20210225:
322         For 64-bit architectures the base system is now built with Position
323         Independent Executable (PIE) support enabled by default.  It may be
324         disabled using the WITHOUT_PIE knob.  A clean build is required.
325
326 20210128:
327         Various LinuxKPI functionality was added which conflicts with DRM.
328         Please update your drm-kmod port to after the __FreeBSD_version 1400003
329         update.
330
331 20210108:
332         PC Card attachments for all devices have been removed. In the case of
333         wi and cmx, the entire drivers were removed because they were only
334         PC Card devices. FreeBSD_version 1300134 should be used for this
335         since it was bumped so recently.
336
337 20210107:
338         Transport-independent parts of HID support have been split off the USB
339         code in to separate subsystem.  Kernel configs which include one of
340         ums, ukbd, uhid, atp, wsp, wmt, uaudio, ugold or ucycom drivers should
341         be updated with adding of "device hid" line.
342
343 20210105:
344         ncurses installation has been modified to only keep the widechar
345         enabled version.  Incremental build is broken for that change, so it
346         requires a clean build.
347
348 20201223:
349         The FreeBSD project has migrated from Subversion to Git. Temporary
350         instructions can be found at
351         https://github.com/bsdimp/freebsd-git-docs/blob/main/src-cvt.md
352         and other documents in that repo.
353
354 20201216:
355         The services database has been updated to cover more of the basic
356         services expected in a modern system. The database is big enough
357         that it will cause issues in mergemaster in Releases previous to
358         12.2 and 11.3, or in very old current systems from before r358154.
359
360 20201215:
361         Obsolete in-tree GDB 6.1.1 has been removed.  GDB (including kgdb)
362         may be installed from ports or packages.
363
364 20201124:
365         ping6 has been merged into ping.  It can now be called as "ping -6".
366         See ping(8) for details.
367
368 20201108:
369         Default value of net.add_addr_allfibs has been changed to 0.
370         If you have multi-fib configuration and rely on existence of all
371         interface routes in every fib, you need to set the above sysctl to 1.
372
373 20201030:
374         The internal pre-processor in the calendar(1) program has been
375         extended to support more C pre-processor commands (e.g. #ifdef, #else,
376         and #undef) and to detect unbalanced conditional statements.
377         Error messages have been extended to include the filename and line
378         number if processing stops to help fixing malformed data files.
379
380 20201026:
381         All the data files for the calendar(1) program, except calendar.freebsd,
382         have been moved to the deskutils/calendar-data port, much like the
383         jewish calendar entries were moved to deskutils/hebcal years ago. After
384         make delete-old-files, you need to install it to retain full
385         functionality. calendar(1) will issue a reminder for files it can't
386         find.
387
388 20200923:
389         LINT files are no longer generated. We now include the relevant NOTES
390         files. Note: This may cause conflicts with updating in some cases.
391                 find sys -name LINT\* -delete
392         is suggested across this commit to remove the generated LINT files.
393
394         If you have tried to update with generated files there, the svn
395         command you want to un-auger the tree is
396                 cd sys/amd64/conf
397                 svn revert -R .
398         and then do the above find from the top level. Substitute 'amd64'
399         above with where the error message indicates a conflict.
400
401 20200824:
402         OpenZFS support has been integrated. Do not upgrade root pools until
403         the loader is updated to support zstd. Furthermore, we caution against
404         'zpool upgrade' for the next few weeks. The change should be transparent
405         unless you  want to use new features.
406
407         Not all "NO_CLEAN" build scenarios work across these changes. Many
408         scenarios have been tested and fixed, but rebuilding kernels without
409         rebuilding world may fail.
410
411         The ZFS cache file has moved from /boot to /etc to match the OpenZFS
412         upstream default. A fallback to /boot has been added for mountroot.
413
414         Pool auto import behavior at boot has been moved from the kernel module
415         to an explicit "zpool import -a" in one of the rc scripts enabled by
416         zfs_enable=YES. This means your non-root zpools won't auto import until
417         you upgrade your /etc/rc.d files.
418
419 20200824:
420         The resume code now notifies devd with the 'kernel' system
421         rather than the old 'kern' subsystem to be consistent with
422         other use. The old notification will be created as well, but
423         will be removed prior to FreeBSD 14.0.
424
425 20200821:
426         r362275 changed the internal API between the kernel RPC and the
427         NFS modules. As such, all the modules must be recompiled from
428         sources.
429
430 20200817:
431         r364330 modified the internal API used between the NFS modules.
432         As such, all the NFS modules must be re-compiled from sources.
433
434 20200816:
435         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
436         been upgraded to 11.0.0.  Please see the 20141231 entry below for
437         information about prerequisites and upgrading, if you are not already
438         using clang 3.5.0 or higher.
439
440 20200810:
441         r364092 modified the internal ABI used between the kernel NFS
442         modules.  As such, all of these modules need to be rebuilt
443         from sources, so a version bump was done.
444
445 20200807:
446         Makefile.inc has been updated to work around the issue documented in
447         20200729. It was a case where the optimization of using symbolic links
448         to point to binaries created a situation where we'd run new binaries
449         with old libraries starting midway through the installworld process.
450
451 20200729:
452         r363679 has redefined some undefined behavior in regcomp(3); notably,
453         extraneous escapes of most ordinary characters will no longer be
454         accepted.  An exp-run has identified all of the problems with this in
455         ports, but other non-ports software may need extra escapes removed to
456         continue to function.
457
458         Because of this change, installworld may encounter the following error
459         from rtld: Undefined symbol "regcomp@FBSD_1.6" -- It is imperative that
460         you do not halt installworld. Instead, let it run to completion (whether
461         successful or not) and run installworld once more.
462
463 20200627:
464         A new implementation of bc and dc has been imported in r362681. This
465         implementation corrects non-conformant behavior of the previous bc
466         and adds GNU bc compatible options. It offers a number of extensions,
467         is much faster on large values, and has support for message catalogs
468         (a number of languages are already supported, contributions of further
469         languages welcome). The option WITHOUT_GH_BC can be used to build the
470         world with the previous versions of bc and dc.
471
472 20200625:
473         r362639 changed the internal API used between the NFS kernel modules.
474         As such, they all need to be rebuilt from sources.
475
476 20200613:
477         r362158 changed the arguments for VFS_CHECKEXP().  As such, any
478         out of tree file systems need to be modified and rebuilt.
479         Also, any file systems that are modules must be rebuilt.
480
481 20200604:
482         read(2) of a directory fd is now rejected by default.  root may
483         re-enable it for system root only on non-ZFS filesystems with the
484         security.bsd.allow_read_dir sysctl(8) MIB if
485         security.bsd.suser_enabled=1.
486
487         It may be advised to setup aliases for grep to default to `-d skip` if
488         commonly non-recursively grepping a list that includes directories and
489         the potential for the resulting stderr output is not tolerable.  Example
490         aliases are now installed, commented out, in /root/.cshrc and
491         /root/.shrc.
492
493 20200523:
494         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
495         been upgraded to 10.0.1.  Please see the 20141231 entry below for
496         information about prerequisites and upgrading, if you are not already
497         using clang 3.5.0 or higher.
498
499 20200512:
500         Support for obsolete compilers has been removed from the build system.
501         Clang 6 and GCC 6.4 are the minimum supported versions.
502
503 20200424:
504         closefrom(2) has been moved under COMPAT12, and replaced in libc with a
505         stub that calls close_range(2).  If using a custom kernel configuration,
506         you may want to ensure that the COMPAT_FREEBSD12 option is included, as
507         a slightly older -CURRENT userland and older FreeBSD userlands may not
508         be functional without closefrom(2).
509
510 20200414:
511         Upstream DTS from Linux 5.6 was merged and they now have the SID
512         and THS (Secure ID controller and THermal Sensor) node present.
513         The DTB overlays have now been removed from the tree for the H3/H5 and
514         A64 SoCs and the aw_sid and aw_thermal driver have been updated to
515         deal with upstream DTS. If you are using those overlays you need to
516         remove them from loader.conf and update the DTBs on the FAT partition.
517
518 20200310:
519         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
520         been upgraded to 10.0.0.  Please see the 20141231 entry below for
521         information about prerequisites and upgrading, if you are not already
522         using clang 3.5.0 or higher.
523
524 20200309:
525         The amd(8) automount daemon has been removed from the source tree.
526         As of FreeBSD 10.1 autofs(5) is the preferred tool for automounting.
527         amd is still available in the sysutils/am-utils port.
528
529 20200301:
530         Removed brooktree driver (bktr.4) from the tree.
531
532 20200229:
533         The WITH_GPL_DTC option has been removed.  The BSD-licenced device tree
534         compiler in usr.bin/dtc is used on all architectures which use dtc, and
535         the GPL dtc is available (if needed) from the sysutils/dtc port.
536
537 20200229:
538         The WITHOUT_LLVM_LIBUNWIND option has been removed.  LLVM's libunwind
539         is used by all supported CPU architectures.
540
541 20200229:
542         GCC 4.2.1 has been removed from the tree.  The WITH_GCC,
543         WITH_GCC_BOOTSTRAP, and WITH_GNUCXX options are no longer available.
544         Users who wish to build FreeBSD with GCC must use the external toolchain
545         ports or packages.
546
547 20200220:
548         ncurses has been updated to a newer version (6.2-20200215). Given the ABI
549         has changed, users will have to rebuild all the ports that are linked to
550         ncurses.
551
552 20200217:
553         The size of struct vnet and the magic cookie have changed.
554         Users need to recompile libkvm and all modules using VIMAGE
555         together with their new kernel.
556
557 20200212:
558         Defining the long deprecated NO_CTF, NO_DEBUG_FILES, NO_INSTALLLIB,
559         NO_MAN, NO_PROFILE, and NO_WARNS variables is now an error.  Update
560         your Makefiles and scripts to define MK_<var>=no instead as required.
561
562         One exception to this is that program or library Makefiles should
563         define MAN to empty rather than setting MK_MAN=no.
564
565 20200108:
566         Clang/LLVM is now the default compiler and LLD the default
567         linker for riscv64.
568
569 20200107:
570         make universe no longer uses GCC 4.2.1 on any architectures.
571         Architectures not supported by in-tree Clang/LLVM require an
572         external toolchain package.
573
574 20200104:
575         GCC 4.2.1 is now not built by default, as part of the GCC 4.2.1
576         retirement plan.  Specifically, the GCC, GCC_BOOTSTRAP, and GNUCXX
577         options default to off for all supported CPU architectures.  As a
578         short-term transition aid they may be enabled via WITH_* options.
579         GCC 4.2.1 is expected to be removed from the tree on 2020-03-31.
580
581 20200102:
582         Support for armv5 has been disconnected and is being removed. The
583         machine combination MACHINE=arm MACHINE_ARCH=arm is no longer valid.
584         You must now use a MACHINE_ARCH of armv6 or armv7. The default
585         MACHINE_ARCH for MACHINE=arm is now armv7.
586
587 20191226:
588         Clang/LLVM is now the default compiler for all powerpc architectures.
589         LLD is now the default linker for powerpc64.  The change for powerpc64
590         also includes a change to the ELFv2 ABI, incompatible with the existing
591         ABI.
592
593 20191226:
594         Kernel-loadable random(4) modules are no longer unloadable.
595
596 20191222:
597         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
598         been upgraded to 9.0.1.  Please see the 20141231 entry below for
599         information about prerequisites and upgrading, if you are not already
600         using clang 3.5.0 or higher.
601
602 20191212:
603         r355677 has modified the internal interface used between the
604         NFS modules in the kernel. As such, they must all be upgraded
605         simultaneously. I will do a version bump for this.
606
607 20191205:
608         The root certificates of the Mozilla CA Certificate Store have been
609         imported into the base system and can be managed with the certctl(8)
610         utility.  If you have installed the security/ca_root_nss port or package
611         with the ETCSYMLINK option (the default), be advised that there may be
612         differences between those included in the port and those included in
613         base due to differences in nss branch used as well as general update
614         frequency.  Note also that certctl(8) cannot manage certs in the
615         format used by the security/ca_root_nss port.
616
617 20191120:
618         The amd(8) automount daemon has been disabled by default, and will be
619         removed in the future.  As of FreeBSD 10.1 the autofs(5) is available
620         for automounting.
621
622 20191107:
623         The nctgpio and wbwd drivers have been moved to the superio bus.
624         If you have one of these drivers in a kernel configuration, then
625         you should add device superio to it.  If you use one of these drivers
626         as a module and you compile a custom set of modules, then you should
627         add superio to the set.
628
629 20191021:
630         KPIs for network drivers to access interface addresses have changed.
631         Users need to recompile NIC driver modules together with kernel.
632
633 20191021:
634         The net.link.tap.user_open sysctl no longer prevents user opening of
635         already created /dev/tapNN devices.  Access is still controlled by
636         node permissions, just like tun devices.  The net.link.tap.user_open
637         sysctl is now used only to allow users to perform devfs cloning of
638         tap devices, and the subsequent open may not succeed if the user is not
639         in the appropriate group.  This sysctl may be deprecated/removed
640         completely in the future.
641
642 20191009:
643         mips, powerpc, and sparc64 are no longer built as part of
644         universe / tinderbox unless MAKE_OBSOLETE_GCC is defined. If
645         not defined, mips, powerpc, and sparc64 builds will look for
646         the xtoolchain binaries and if installed use them for universe
647         builds. As llvm 9.0 becomes vetted for these architectures, they
648         will be removed from the list.
649
650 20191009:
651         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
652         been upgraded to 9.0.0.  Please see the 20141231 entry below for
653         information about prerequisites and upgrading, if you are not already
654         using clang 3.5.0 or higher.
655
656 20191003:
657         The hpt27xx, hptmv, hptnr, and hptrr drivers have been removed from
658         GENERIC.  They are available as modules and can be loaded by adding
659         to /boot/loader.conf hpt27xx_load="YES", hptmv_load="YES",
660         hptnr_load="YES", or hptrr_load="YES", respectively.
661
662 20190913:
663         ntpd no longer by default locks its pages in memory, allowing them
664         to be paged out by the kernel. Use rlimit memlock to restore
665         historic BSD behaviour. For example, add "rlimit memlock 32"
666         to ntp.conf to lock up to 32 MB of ntpd address space in memory.
667
668 20190823:
669         Several of ping6's options have been renamed for better consistency
670         with ping.  If you use any of -ARWXaghmrtwx, you must update your
671         scripts.  See ping6(8) for details.
672
673 20190727:
674         The vfs.fusefs.sync_unmount and vfs.fusefs.init_backgrounded sysctls
675         and the "-o sync_unmount" and "-o init_backgrounded" mount options have
676         been removed from mount_fusefs(8).  You can safely remove them from
677         your scripts, because they had no effect.
678
679         The vfs.fusefs.fix_broken_io, vfs.fusefs.sync_resize,
680         vfs.fusefs.refresh_size, vfs.fusefs.mmap_enable,
681         vfs.fusefs.reclaim_revoked, and vfs.fusefs.data_cache_invalidate
682         sysctls have been removed.  If you felt the need to set any of them to
683         a non-default value, please tell asomers@FreeBSD.org why.
684
685 20190713:
686         Default permissions on the /var/account/acct file (and copies of it
687         rotated by periodic daily scripts) are changed from 0644 to 0640
688         because the file contains sensitive information that should not be
689         world-readable.  If the /var/account directory must be created by
690         rc.d/accounting, the mode used is now 0750.  Admins who use the
691         accounting feature are encouraged to change the mode of an existing
692         /var/account directory to 0750 or 0700.
693
694 20190620:
695         Entropy collection and the /dev/random device are no longer optional
696         components.  The "device random" option has been removed.
697         Implementations of distilling algorithms can still be made loadable
698         with "options RANDOM_LOADABLE" (e.g., random_fortuna.ko).
699
700 20190612:
701         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
702         been upgraded to 8.0.1.  Please see the 20141231 entry below for
703         information about prerequisites and upgrading, if you are not already
704         using clang 3.5.0 or higher.
705
706 20190608:
707         A fix was applied to i386 kernel modules to avoid panics with
708         dpcpu or vnet.  Users need to recompile i386 kernel modules
709         having pcpu or vnet sections or they will refuse to load.
710
711 20190513:
712         User-wired pages now have their own counter,
713         vm.stats.vm.v_user_wire_count.  The vm.max_wired sysctl was renamed
714         to vm.max_user_wired and changed from an unsigned int to an unsigned
715         long.  bhyve VMs wired with the -S are now subject to the user
716         wiring limit; the vm.max_user_wired sysctl may need to be tuned to
717         avoid running into the limit.
718
719 20190507:
720         The IPSEC option has been removed from GENERIC.  Users requiring
721         ipsec(4) must now load the ipsec(4) kernel module.
722
723 20190507:
724         The tap(4) driver has been folded into tun(4), and the module has been
725         renamed to tuntap.  You should update any kld_list="if_tap" or
726         kld_list="if_tun" entries in /etc/rc.conf, if_tap_load="YES" or
727         if_tun_load="YES" entries in /boot/loader.conf to load the if_tuntap
728         module instead, and "device tap" or "device tun" entries in kernel
729         config files to select the tuntap device instead.
730
731 20190418:
732         The following knobs have been added related to tradeoffs between
733         safe use of the random device and availability in the absence of
734         entropy:
735
736         kern.random.initial_seeding.bypass_before_seeding: tunable; set
737         non-zero to bypass the random device prior to seeding, or zero to
738         block random requests until the random device is initially seeded.
739         For now, set to 1 (unsafe) by default to restore pre-r346250 boot
740         availability properties.
741
742         kern.random.initial_seeding.read_random_bypassed_before_seeding:
743         read-only diagnostic sysctl that is set when bypass is enabled and
744         read_random(9) is bypassed, to enable programmatic handling of this
745         initial condition, if desired.
746
747         kern.random.initial_seeding.arc4random_bypassed_before_seeding:
748         Similar to the above, but for arc4random(9) initial seeding.
749
750         kern.random.initial_seeding.disable_bypass_warnings: tunable; set
751         non-zero to disable warnings in dmesg when the same conditions are
752         met as for the diagnostic sysctls above.  Defaults to zero, i.e.,
753         produce warnings in dmesg when the conditions are met.
754
755 20190416:
756         The loadable random module KPI has changed; the random_infra_init()
757         routine now requires a 3rd function pointer for a bool (*)(void)
758         method that returns true if the random device is seeded (and
759         therefore unblocked).
760
761 20190404:
762         r345895 reverts r320698. This implies that an nfsuserd(8) daemon
763         built from head sources between r320757 (July 6, 2017) and
764         r338192 (Aug. 22, 2018) will not work unless the "-use-udpsock"
765         is added to the command line.
766         nfsuserd daemons built from head sources that are post-r338192 are
767         not affected and should continue to work.
768
769 20190320:
770         The fuse(4) module has been renamed to fusefs(4) for consistency with
771         other filesystems.  You should update any kld_load="fuse" entries in
772         /etc/rc.conf, fuse_load="YES" entries in /boot/loader.conf, and
773         "options FUSE" entries in kernel config files.
774
775 20190304:
776         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
777         8.0.0.  Please see the 20141231 entry below for information about
778         prerequisites and upgrading, if you are not already using clang 3.5.0
779         or higher.
780
781 20190226:
782         geom_uzip(4) depends on the new module xz.  If geom_uzip is statically
783         compiled into your custom kernel, add 'device xz' statement to the
784         kernel config.
785
786 20190219:
787         drm and drm2 have been removed from the tree. Please see
788         https://wiki.freebsd.org/Graphics for the latest information on
789         migrating to the drm ports.
790
791 20190131:
792         Iflib is no longer unconditionally compiled into the kernel.  Drivers
793         using iflib and statically compiled into the kernel, now require
794         the 'device iflib' config option.  For the same drivers loaded as
795         modules on kernels not having 'device iflib', the iflib.ko module
796         is loaded automatically.
797
798 20190125:
799         The IEEE80211_AMPDU_AGE and AH_SUPPORT_AR5416 kernel configuration
800         options no longer exist since r343219 and r343427 respectively;
801         nothing uses them, so they should be just removed from custom
802         kernel config files.
803
804 20181230:
805         r342635 changes the way efibootmgr(8) works by requiring users to add
806         the -b (bootnum) parameter for commands where the bootnum was previously
807         specified with each option. For example 'efibootmgr -B 0001' is now
808         'efibootmgr -B -b 0001'.
809
810 20181220:
811         r342286 modifies the NFSv4 server so that it obeys vfs.nfsd.nfs_privport
812         in the same as it is applied to NFSv2 and 3.  This implies that NFSv4
813         servers that have vfs.nfsd.nfs_privport set will only allow mounts
814         from clients using a reserved port. Since both the FreeBSD and Linux
815         NFSv4 clients use reserved ports by default, this should not affect
816         most NFSv4 mounts.
817
818 20181219:
819         The XLP config has been removed. We can't support 64-bit atomics in this
820         kernel because it is running in 32-bit mode. XLP users must transition
821         to running a 64-bit kernel (XLP64 or XLPN32).
822
823         The mips GXEMUL support has been removed from FreeBSD. MALTA* + qemu is
824         the preferred emulator today and we don't need two different ones.
825
826         The old sibyte / swarm / Broadcom BCM1250 support has been
827         removed from the mips port.
828
829 20181211:
830         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
831         7.0.1.  Please see the 20141231 entry below for information about
832         prerequisites and upgrading, if you are not already using clang 3.5.0
833         or higher.
834
835 20181211:
836         Remove the timed and netdate programs from the base tree.  Setting
837         the time with these daemons has been obsolete for over a decade.
838
839 20181126:
840         On amd64, arm64 and armv7 (architectures that install LLVM's ld.lld
841         linker as /usr/bin/ld) GNU ld is no longer installed as ld.bfd, as
842         it produces broken binaries when ifuncs are in use.  Users needing
843         GNU ld should install the binutils port or package.
844
845 20181123:
846         The BSD crtbegin and crtend code has been enabled by default. It has
847         had extensive testing on amd64, arm64, and i386. It can be disabled
848         by building a world with -DWITHOUT_BSD_CRTBEGIN.
849
850 20181115:
851         The set of CTM commands (ctm, ctm_smail, ctm_rmail, ctm_dequeue)
852         has been converted to a port (misc/ctm) and will be removed from
853         FreeBSD-13.  It is available as a package (ctm) for all supported
854         FreeBSD versions.
855
856 20181110:
857         The default newsyslog.conf(5) file has been changed to only include
858         files in /etc/newsyslog.conf.d/ and /usr/local/etc/newsyslog.conf.d/ if
859         the filenames end in '.conf' and do not begin with a '.'.
860
861         You should check the configuration files in these two directories match
862         this naming convention. You can verify which configuration files are
863         being included using the command:
864                 $ newsyslog -Nrv
865
866 20181015:
867         Ports for the DRM modules have been simplified. Now, amd64 users should
868         just install the drm-kmod port. All others should install
869         drm-legacy-kmod.
870
871         Graphics hardware that's newer than about 2010 usually works with
872         drm-kmod.  For hardware older than 2013, however, some users will need
873         to use drm-legacy-kmod if drm-kmod doesn't work for them. Hardware older
874         than 2008 usually only works in drm-legacy-kmod. The graphics team can
875         only commit to hardware made since 2013 due to the complexity of the
876         market and difficulty to test all the older cards effectively. If you
877         have hardware supported by drm-kmod, you are strongly encouraged to use
878         that as you will get better support.
879
880         Other than KPI chasing, drm-legacy-kmod will not be updated. As outlined
881         elsewhere, the drm and drm2 modules will be eliminated from the src base
882         soon (with a limited exception for arm). Please update to the package
883         asap and report any issues to x11@freebsd.org.
884
885         Generally, anybody using the drm*-kmod packages should add
886         WITHOUT_DRM_MODULE=t and WITHOUT_DRM2_MODULE=t to avoid nasty
887         cross-threading surprises, especially with automatic driver
888         loading from X11 startup. These will become the defaults in 13-current
889         shortly.
890
891 20181012:
892         The ixlv(4) driver has been renamed to iavf(4).  As a consequence,
893         custom kernel and module loading configuration files must be updated
894         accordingly.  Moreover, interfaces previous presented as ixlvN to the
895         system are now exposed as iavfN and network configuration files must
896         be adjusted as necessary.
897
898 20181009:
899         OpenSSL has been updated to version 1.1.1.  This update included
900         additional various API changes throughout the base system.  It is
901         important to rebuild third-party software after upgrading.  The value
902         of __FreeBSD_version has been bumped accordingly.
903
904 20181006:
905         The legacy DRM modules and drivers have now been added to the loader's
906         module blacklist, in favor of loading them with kld_list in rc.conf(5).
907         The module blacklist may be overridden with the loader.conf(5)
908         'module_blacklist' variable, but loading them via rc.conf(5) is strongly
909         encouraged.
910
911 20181002:
912         The cam(4) based nda(4) driver will be used over nvd(4) by default on
913         powerpc64. You may set 'options NVME_USE_NVD=1' in your kernel conf or
914         loader tunable 'hw.nvme.use_nvd=1' if you wish to use the existing
915         driver.  Make sure to edit /boot/etc/kboot.conf and fstab to use the
916         nda device name.
917
918 20180913:
919         Reproducible build mode is now on by default, in preparation for
920         FreeBSD 12.0.  This eliminates build metadata such as the user,
921         host, and time from the kernel (and uname), unless the working tree
922         corresponds to a modified checkout from a version control system.
923         The previous behavior can be obtained by setting the /etc/src.conf
924         knob WITHOUT_REPRODUCIBLE_BUILD.
925
926 20180826:
927         The Yarrow CSPRNG has been removed from the kernel as it has not been
928         supported by its designers since at least 2003. Fortuna has been the
929         default since FreeBSD-11.
930
931 20180822:
932         devctl freeze/thaw have gone into the tree, the rc scripts have been
933         updated to use them and devmatch has been changed.  You should update
934         kernel, userland and rc scripts all at the same time.
935
936 20180818:
937         The default interpreter has been switched from 4th to Lua.
938         LOADER_DEFAULT_INTERP, documented in build(7), will override the default
939         interpreter.  If you have custom FORTH code you will need to set
940         LOADER_DEFAULT_INTERP=4th (valid values are 4th, lua or simp) in
941         src.conf for the build.  This will create default hard links between
942         loader and loader_4th instead of loader and loader_lua, the new default.
943         If you are using UEFI it will create the proper hard link to loader.efi.
944
945         bhyve uses userboot.so. It remains 4th-only until some issues are solved
946         regarding coexisting with multiple versions of FreeBSD are resolved.
947
948 20180815:
949         ls(1) now respects the COLORTERM environment variable used in other
950         systems and software to indicate that a colored terminal is both
951         supported and desired.  If ls(1) is suddenly emitting colors, they may
952         be disabled again by either removing the unwanted COLORTERM from your
953         environment, or using `ls --color=never`.  The ls(1) specific CLICOLOR
954         may not be observed in a future release.
955
956 20180808:
957         The default pager for most commands has been changed to "less".  To
958         restore the old behavior, set PAGER="more" and MANPAGER="more -s" in
959         your environment.
960
961 20180731:
962         The jedec_ts(4) driver has been removed. A superset of its functionality
963         is available in the jedec_dimm(4) driver, and the manpage for that
964         driver includes migration instructions. If you have "device jedec_ts"
965         in your kernel configuration file, it must be removed.
966
967 20180730:
968         amd64/GENERIC now has EFI runtime services, EFIRT, enabled by default.
969         This should have no effect if the kernel is booted via BIOS/legacy boot.
970         EFIRT may be disabled via a loader tunable, efi.rt.disabled, if a system
971         has a buggy firmware that prevents a successful boot due to use of
972         runtime services.
973
974 20180727:
975         Atmel AT91RM9200 and AT91SAM9, Cavium CNS 11xx and XScale
976         support has been removed from the tree. These ports were
977         obsolete and/or known to be broken for many years.
978
979 20180723:
980         loader.efi has been augmented to participate more fully in the
981         UEFI boot manager protocol. loader.efi will now look at the
982         BootXXXX environment variable to determine if a specific kernel
983         or root partition was specified. XXXX is derived from BootCurrent.
984         efibootmgr(8) manages these standard UEFI variables.
985
986 20180720:
987         zfsloader's functionality has now been folded into loader.
988         zfsloader is no longer necessary once you've updated your
989         boot blocks. For a transition period, we will install a
990         hardlink for zfsloader to loader to allow a smooth transition
991         until the boot blocks can be updated (hard link because old
992         zfs boot blocks don't understand symlinks).
993
994 20180719:
995         ARM64 now have efifb support, if you want to have serial console
996         on your arm64 board when an screen is connected and the bootloader
997         setup a frame buffer for us to use, just add :
998         boot_serial=YES
999         boot_multicons=YES
1000         in /boot/loader.conf
1001         For Raspberry Pi 3 (RPI) users, this is needed even if you don't have
1002         an screen connected as the firmware will setup a frame buffer are that
1003         u-boot will expose as an EFI frame buffer.
1004
1005 20180719:
1006         New uid:gid added, ntpd:ntpd (123:123).  Be sure to run mergemaster
1007         or take steps to update /etc/passwd before doing installworld on
1008         existing systems.  Do not skip the "mergemaster -Fp" step before
1009         installworld, as described in the update procedures near the bottom
1010         of this document.  Also, rc.d/ntpd now starts ntpd(8) as user ntpd
1011         if the new mac_ntpd(4) policy is available, unless ntpd_flags or
1012         the ntp config file contain options that change file/dir locations.
1013         When such options (e.g., "statsdir" or "crypto") are used, ntpd can
1014         still be run as non-root by setting ntpd_user=ntpd in rc.conf, after
1015         taking steps to ensure that all required files/dirs are accessible
1016         by the ntpd user.
1017
1018 20180717:
1019         Big endian arm support has been removed.
1020
1021 20180711:
1022         The static environment setup in kernel configs is no longer mutually
1023         exclusive with the loader(8) environment by default.  In order to
1024         restore the previous default behavior of disabling the loader(8)
1025         environment if a static environment is present, you must specify
1026         loader_env.disabled=1 in the static environment.
1027
1028 20180705:
1029         The ABI of syscalls used by management tools like sockstat and
1030         netstat has been broken to allow 32-bit binaries to work on
1031         64-bit kernels without modification.  These programs will need
1032         to match the kernel in order to function.  External programs may
1033         require minor modifications to accommodate a change of type in
1034         structures from pointers to 64-bit virtual addresses.
1035
1036 20180702:
1037         On i386 and amd64 atomics are now inlined. Out of tree modules using
1038         atomics will need to be rebuilt.
1039
1040 20180701:
1041         The '%I' format in the kern.corefile sysctl limits the number of
1042         core files that a process can generate to the number stored in the
1043         debug.ncores sysctl. The '%I' format is replaced by the single digit
1044         index. Previously, if all indexes were taken the kernel would overwrite
1045         only a core file with the highest index in a filename.
1046         Currently the system will create a new core file if there is a free
1047         index or if all slots are taken it will overwrite the oldest one.
1048
1049 20180630:
1050         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
1051         6.0.1.  Please see the 20141231 entry below for information about
1052         prerequisites and upgrading, if you are not already using clang 3.5.0
1053         or higher.
1054
1055 20180628:
1056         r335753 introduced a new quoting method. However, etc/devd/devmatch.conf
1057         needed to be changed to work with it. This change was made with r335763
1058         and requires a mergemaster / etcupdate / etc to update the installed
1059         file.
1060
1061 20180612:
1062         r334930 changed the interface between the NFS modules, so they all
1063         need to be rebuilt.  r335018 did a __FreeBSD_version bump for this.
1064
1065 20180530:
1066         As of r334391 lld is the default amd64 system linker; it is installed
1067         as /usr/bin/ld.  Kernel build workarounds (see 20180510 entry) are no
1068         longer necessary.
1069
1070 20180530:
1071         The kernel / userland interface for devinfo changed, so you'll
1072         need a new kernel and userland as a pair for it to work (rebuilding
1073         lib/libdevinfo is all that's required). devinfo and devmatch will
1074         not work, but everything else will when there's a mismatch.
1075
1076 20180523:
1077         The on-disk format for hwpmc callchain records has changed to include
1078         threadid corresponding to a given record. This changes the field offsets
1079         and thus requires that libpmcstat be rebuilt before using a kernel
1080         later than r334108.
1081
1082 20180517:
1083         The vxge(4) driver has been removed.  This driver was introduced into
1084         HEAD one week before the Exar left the Ethernet market and is not
1085         known to be used.  If you have device vxge in your kernel config file
1086         it must be removed.
1087
1088 20180510:
1089         The amd64 kernel now requires a ld that supports ifunc to produce a
1090         working kernel, either lld or a newer binutils. lld is built by default
1091         on amd64, and the 'buildkernel' target uses it automatically. However,
1092         it is not the default linker, so building the kernel the traditional
1093         way requires LD=ld.lld on the command line (or LD=/usr/local/bin/ld for
1094         binutils port/package). lld will soon be default, and this requirement
1095         will go away.
1096
1097         NOTE: As of r334391 lld is the default system linker on amd64, and no
1098         workaround is necessary.
1099
1100 20180508:
1101         The nxge(4) driver has been removed.  This driver was for PCI-X 10g
1102         cards made by s2io/Neterion.  The company was acquired by Exar and
1103         no longer sells or supports Ethernet products.  If you have device
1104         nxge in your kernel config file it must be removed.
1105
1106 20180504:
1107         The tz database (tzdb) has been updated to 2018e.  This version more
1108         correctly models time stamps in time zones with negative DST such as
1109         Europe/Dublin (from 1971 on), Europe/Prague (1946/7), and
1110         Africa/Windhoek (1994/2017).  This does not affect the UT offsets, only
1111         time zone abbreviations and the tm_isdst flag.
1112
1113 20180502:
1114         The ixgb(4) driver has been removed.  This driver was for an early and
1115         uncommon legacy PCI 10GbE for a single ASIC, Intel 82597EX. Intel
1116         quickly shifted to the long lived ixgbe family.  If you have device
1117         ixgb in your kernel config file it must be removed.
1118
1119 20180501:
1120         The lmc(4) driver has been removed.  This was a WAN interface
1121         card that was already reportedly rare in 2003, and had an ambiguous
1122         license.  If you have device lmc in your kernel config file it must
1123         be removed.
1124
1125 20180413:
1126         Support for Arcnet networks has been removed.  If you have device
1127         arcnet or device cm in your kernel config file they must be
1128         removed.
1129
1130 20180411:
1131         Support for FDDI networks has been removed.  If you have device
1132         fddi or device fpa in your kernel config file they must be
1133         removed.
1134
1135 20180406:
1136         In addition to supporting RFC 3164 formatted messages, the
1137         syslogd(8) service is now capable of parsing RFC 5424 formatted
1138         log messages. The main benefit of using RFC 5424 is that clients
1139         may now send log messages with timestamps containing year numbers,
1140         microseconds and time zone offsets.
1141
1142         Similarly, the syslog(3) C library function has been altered to
1143         send RFC 5424 formatted messages to the local system logging
1144         daemon. On systems using syslogd(8), this change should have no
1145         negative impact, as long as syslogd(8) and the C library are
1146         updated at the same time. On systems using a different system
1147         logging daemon, it may be necessary to make configuration
1148         adjustments, depending on the software used.
1149
1150         When using syslog-ng, add the 'syslog-protocol' flag to local
1151         input sources to enable parsing of RFC 5424 formatted messages:
1152
1153                 source src {
1154                         unix-dgram("/var/run/log" flags(syslog-protocol));
1155                 }
1156
1157         When using rsyslog, disable the 'SysSock.UseSpecialParser' option
1158         of the 'imuxsock' module to let messages be processed by the
1159         regular RFC 3164/5424 parsing pipeline:
1160
1161                 module(load="imuxsock" SysSock.UseSpecialParser="off")
1162
1163         Do note that these changes only affect communication between local
1164         applications and syslogd(8). The format that syslogd(8) uses to
1165         store messages on disk or forward messages to other systems
1166         remains unchanged. syslogd(8) still uses RFC 3164 for these
1167         purposes. Options to customize this behaviour will be added in the
1168         future. Utilities that process log files stored in /var/log are
1169         thus expected to continue to function as before.
1170
1171         __FreeBSD_version has been incremented to 1200061 to denote this
1172         change.
1173
1174 20180328:
1175         Support for token ring networks has been removed. If you
1176         have "device token" in your kernel config you should remove
1177         it. No device drivers supported token ring.
1178
1179 20180323:
1180         makefs was modified to be able to tag ISO9660 El Torito boot catalog
1181         entries as EFI instead of overloading the i386 tag as done previously.
1182         The amd64 mkisoimages.sh script used to build amd64 ISO images for
1183         release was updated to use this. This may mean that makefs must be
1184         updated before "make cdrom" can be run in the release directory. This
1185         should be as simple as:
1186
1187                 $ cd $SRCDIR/usr.sbin/makefs
1188                 $ make depend all install
1189
1190 20180212:
1191         FreeBSD boot loader enhanced with Lua scripting. It's purely opt-in for
1192         now by building WITH_LOADER_LUA and WITHOUT_FORTH in /etc/src.conf.
1193         Co-existence for the transition period will come shortly. Booting is a
1194         complex environment and test coverage for Lua-enabled loaders has been
1195         thin, so it would be prudent to assume it might not work and make
1196         provisions for backup boot methods.
1197
1198 20180211:
1199         devmatch functionality has been turned on in devd. It will automatically
1200         load drivers for unattached devices. This may cause unexpected drivers
1201         to be loaded. Please report any problems to current@ and
1202         imp@freebsd.org.
1203
1204 20180114:
1205         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
1206         6.0.0.  Please see the 20141231 entry below for information about
1207         prerequisites and upgrading, if you are not already using clang 3.5.0
1208         or higher.
1209
1210 20180110:
1211         LLVM's lld linker is now used as the FreeBSD/amd64 bootstrap linker.
1212         This means it is used to link the kernel and userland libraries and
1213         executables, but is not yet installed as /usr/bin/ld by default.
1214
1215         To revert to ld.bfd as the bootstrap linker, in /etc/src.conf set
1216         WITHOUT_LLD_BOOTSTRAP=yes
1217
1218 20180110:
1219         On i386, pmtimer has been removed. Its functionality has been folded
1220         into apm. It was a no-op on ACPI in current for a while now (but was
1221         still needed on i386 in FreeBSD 11 and earlier). Users may need to
1222         remove it from kernel config files.
1223
1224 20180104:
1225         The use of RSS hash from the network card aka flowid has been
1226         disabled by default for lagg(4) as it's currently incompatible with
1227         the lacp and loadbalance protocols.
1228
1229         This can be re-enabled by setting the following in loader.conf:
1230         net.link.lagg.default_use_flowid="1"
1231
1232 20180102:
1233         The SW_WATCHDOG option is no longer necessary to enable the
1234         hardclock-based software watchdog if no hardware watchdog is
1235         configured. As before, SW_WATCHDOG will cause the software
1236         watchdog to be enabled even if a hardware watchdog is configured.
1237
1238 20171215:
1239         r326887 fixes the issue described in the 20171214 UPDATING entry.
1240         r326888 flips the switch back to building GELI support always.
1241
1242 20171214:
1243         r362593 broke ZFS + GELI support for reasons unknown. However,
1244         it also broke ZFS support generally, so GELI has been turned off
1245         by default as the lesser evil in r326857. If you boot off ZFS and/or
1246         GELI, it might not be a good time to update.
1247
1248 20171125:
1249         PowerPC users must update loader(8) by rebuilding world before
1250         installing a new kernel, as the protocol connecting them has
1251         changed. Without the update, loader metadata will not be passed
1252         successfully to the kernel and users will have to enter their
1253         root partition at the kernel mountroot prompt to continue booting.
1254         Newer versions of loader can boot old kernels without issue.
1255
1256 20171110:
1257         The LOADER_FIREWIRE_SUPPORT build variable has been renamed to
1258         WITH/OUT_LOADER_FIREWIRE. LOADER_{NO_,}GELI_SUPPORT has been renamed
1259         to WITH/OUT_LOADER_GELI.
1260
1261 20171106:
1262         The naive and non-compliant support of posix_fallocate(2) in ZFS
1263         has been removed as of r325320.  The system call now returns EINVAL
1264         when used on a ZFS file.  Although the new behavior complies with the
1265         standard, some consumers are not prepared to cope with it.
1266         One known victim is lld prior to r325420.
1267
1268 20171102:
1269         Building in a FreeBSD src checkout will automatically create object
1270         directories now rather than store files in the current directory if
1271         'make obj' was not ran.  Calling 'make obj' is no longer necessary.
1272         This feature can be disabled by setting WITHOUT_AUTO_OBJ=yes in
1273         /etc/src-env.conf (not /etc/src.conf), or passing the option in the
1274         environment.
1275
1276 20171101:
1277         The default MAKEOBJDIR has changed from /usr/obj/<srcdir> for native
1278         builds, and /usr/obj/<arch>/<srcdir> for cross-builds, to a unified
1279         /usr/obj/<srcdir>/<arch>.  This behavior can be changed to the old
1280         format by setting WITHOUT_UNIFIED_OBJDIR=yes in /etc/src-env.conf,
1281         the environment, or with -DWITHOUT_UNIFIED_OBJDIR when building.
1282         The UNIFIED_OBJDIR option is a transitional feature that will be
1283         removed for 12.0 release; please migrate to the new format for any
1284         tools by looking up the OBJDIR used by 'make -V .OBJDIR' means rather
1285         than hardcoding paths.
1286
1287 20171028:
1288         The native-xtools target no longer installs the files by default to the
1289         OBJDIR.  Use the native-xtools-install target with a DESTDIR to install
1290         to ${DESTDIR}/${NXTP} where NXTP defaults to /nxb-bin.
1291
1292 20171021:
1293         As part of the boot loader infrastructure cleanup, LOADER_*_SUPPORT
1294         options are changing from controlling the build if defined / undefined
1295         to controlling the build with explicit 'yes' or 'no' values. They will
1296         shift to WITH/WITHOUT options to match other options in the system.
1297
1298 20171010:
1299         libstand has turned into a private library for sys/boot use only.
1300         It is no longer supported as a public interface outside of sys/boot.
1301
1302 20171005:
1303         The arm port has split armv6 into armv6 and armv7. armv7 is now
1304         a valid TARGET_ARCH/MACHINE_ARCH setting. If you have an armv7 system
1305         and are running a kernel from before r324363, you will need to add
1306         MACHINE_ARCH=armv7 to 'make buildworld' to do a native build.
1307
1308 20171003:
1309         When building multiple kernels using KERNCONF, non-existent KERNCONF
1310         files will produce an error and buildkernel will fail. Previously
1311         missing KERNCONF files silently failed giving no indication as to
1312         why, only to subsequently discover during installkernel that the
1313         desired kernel was never built in the first place.
1314
1315 20170912:
1316         The default serial number format for CTL LUNs has changed.  This will
1317         affect users who use /dev/diskid/* device nodes, or whose FibreChannel
1318         or iSCSI clients care about their LUNs' serial numbers.  Users who
1319         require serial number stability should hardcode serial numbers in
1320         /etc/ctl.conf .
1321
1322 20170912:
1323         For 32-bit arm compiled for hard-float support, soft-floating point
1324         binaries now always get their shared libraries from
1325         LD_SOFT_LIBRARY_PATH (in the past, this was only used if
1326         /usr/libsoft also existed). Only users with a hard-float ld.so, but
1327         soft-float everything else should be affected.
1328
1329 20170826:
1330         The geli password typed at boot is now hidden.  To restore the previous
1331         behavior, see geli(8) for configuration options.
1332
1333 20170825:
1334         Move PMTUD blackhole counters to TCPSTATS and remove them from bare
1335         sysctl values.  Minor nit, but requires a rebuild of both world/kernel
1336         to complete.
1337
1338 20170814:
1339         "make check" behavior (made in ^/head@r295380) has been changed to
1340         execute from a limited sandbox, as opposed to executing from
1341         ${TESTSDIR}.
1342
1343         Behavioral changes:
1344         - The "beforecheck" and "aftercheck" targets are now specified.
1345         - ${CHECKDIR} (added in commit noted above) has been removed.
1346         - Legacy behavior can be enabled by setting
1347           WITHOUT_MAKE_CHECK_USE_SANDBOX in src.conf(5) or the environment.
1348
1349         If the limited sandbox mode is enabled, "make check" will execute
1350         "make distribution", then install, execute the tests, and clean up the
1351         sandbox if successful.
1352
1353         The "make distribution" and "make install" targets are typically run as
1354         root to set appropriate permissions and ownership at installation time.
1355         The end-user should set "WITH_INSTALL_AS_USER" in src.conf(5) or the
1356         environment if executing "make check" with limited sandbox mode using
1357         an unprivileged user.
1358
1359 20170808:
1360         Since the switch to GPT disk labels, fsck for UFS/FFS has been
1361         unable to automatically find alternate superblocks. As of r322297,
1362         the information needed to find alternate superblocks has been
1363         moved to the end of the area reserved for the boot block.
1364         Filesystems created with a newfs of this vintage or later
1365         will create the recovery information. If you have a filesystem
1366         created prior to this change and wish to have a recovery block
1367         created for your filesystem, you can do so by running fsck in
1368         foreground mode (i.e., do not use the -p or -y options). As it
1369         starts, fsck will ask ``SAVE DATA TO FIND ALTERNATE SUPERBLOCKS''
1370         to which you should answer yes.
1371
1372 20170728:
1373         As of r321665, an NFSv4 server configuration that services
1374         Kerberos mounts or clients that do not support the uid/gid in
1375         owner/owner_group string capability, must explicitly enable
1376         the nfsuserd daemon by adding nfsuserd_enable="YES" to the
1377         machine's /etc/rc.conf file.
1378
1379 20170722:
1380         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 5.0.0.
1381         Please see the 20141231 entry below for information about prerequisites
1382         and upgrading, if you are not already using clang 3.5.0 or higher.
1383
1384 20170701:
1385         WITHOUT_RCMDS is now the default. Set WITH_RCMDS if you need the
1386         r-commands (rlogin, rsh, etc.) to be built with the base system.
1387
1388 20170625:
1389         The FreeBSD/powerpc platform now uses a 64-bit type for time_t.  This is
1390         a very major ABI incompatible change, so users of FreeBSD/powerpc must
1391         be careful when performing source upgrades.  It is best to run
1392         'make installworld' from an alternate root system, either a live
1393         CD/memory stick, or a temporary root partition.  Additionally, all ports
1394         must be recompiled.  powerpc64 is largely unaffected, except in the case
1395         of 32-bit compatibility.  All 32-bit binaries will be affected.
1396
1397 20170623:
1398         Forward compatibility for the "ino64" project have been committed. This
1399         will allow most new binaries to run on older kernels in a limited
1400         fashion.  This prevents many of the common foot-shooting actions in the
1401         upgrade as well as the limited ability to roll back the kernel across
1402         the ino64 upgrade. Complicated use cases may not work properly, though
1403         enough simpler ones work to allow recovery in most situations.
1404
1405 20170620:
1406         Switch back to the BSDL dtc (Device Tree Compiler). Set WITH_GPL_DTC
1407         if you require the GPL compiler.
1408
1409 20170618:
1410         The internal ABI used for communication between the NFS kernel modules
1411         was changed by r320085, so __FreeBSD_version was bumped to
1412         ensure all the NFS related modules are updated together.
1413
1414 20170617:
1415         The ABI of struct event was changed by extending the data
1416         member to 64bit and adding ext fields.  For upgrade, same
1417         precautions as for the entry 20170523 "ino64" must be
1418         followed.
1419
1420 20170531:
1421         The GNU roff toolchain has been removed from base. To render manpages
1422         which are not supported by mandoc(1), man(1) can fallback on GNU roff
1423         from ports (and recommends to install it).
1424         To render roff(7) documents, consider using GNU roff from ports or the
1425         heirloom doctools roff toolchain from ports via pkg install groff or
1426         via pkg install heirloom-doctools.
1427
1428 20170524:
1429         The ath(4) and ath_hal(4) modules now build piecemeal to allow for
1430         smaller runtime footprint builds.  This is useful for embedded systems
1431         which only require one chipset support.
1432
1433         If you load it as a module, make sure this is in /boot/loader.conf:
1434
1435         if_ath_load="YES"
1436
1437         This will load the HAL, all chip/RF backends and if_ath_pci.
1438         If you have if_ath_pci in /boot/loader.conf, ensure it is after
1439         if_ath or it will not load any HAL chipset support.
1440
1441         If you want to selectively load things (eg on cheaper ARM/MIPS
1442         platforms where RAM is at a premium) you should:
1443
1444         * load ath_hal
1445         * load the chip modules in question
1446         * load ath_rate, ath_dfs
1447         * load ath_main
1448         * load if_ath_pci and/or if_ath_ahb depending upon your particular
1449           bus bind type - this is where probe/attach is done.
1450
1451         For further comments/feedback, poke adrian@ .
1452
1453 20170523:
1454         The "ino64" 64-bit inode project has been committed, which extends
1455         a number of types to 64 bits.  Upgrading in place requires care and
1456         adherence to the documented upgrade procedure.
1457
1458         If using a custom kernel configuration ensure that the
1459         COMPAT_FREEBSD11 option is included (as during the upgrade the
1460         system will be running the ino64 kernel with the existing world).
1461
1462         For the safest in-place upgrade begin by removing previous build
1463         artifacts via "rm -rf /usr/obj/*".  Then, carefully follow the full
1464         procedure documented below under the heading "To rebuild everything and
1465         install it on the current system."  Specifically, a reboot is required
1466         after installing the new kernel before installing world. While an
1467         installworld normally works by accident from multiuser after rebooting
1468         the proper kernel, there are many cases where this will fail across this
1469         upgrade and installworld from single user is required.
1470
1471 20170424:
1472         The NATM framework including the en(4), fatm(4), hatm(4), and
1473         patm(4) devices has been removed.  Consumers should plan a
1474         migration before the end-of-life date for FreeBSD 11.
1475
1476 20170420:
1477         GNU diff has been replaced by a BSD licensed diff. Some features of GNU
1478         diff has not been implemented, if those are needed a newer version of
1479         GNU diff is available via the diffutils package under the gdiff name.
1480
1481 20170413:
1482         As of r316810 for ipfilter, keep frags is no longer assumed when
1483         keep state is specified in a rule. r316810 aligns ipfilter with
1484         documentation in man pages separating keep frags from keep state.
1485         This allows keep state to be specified without forcing keep frags
1486         and allows keep frags to be specified independently of keep state.
1487         To maintain previous behaviour, also specify keep frags with
1488         keep state (as documented in ipf.conf.5).
1489
1490 20170407:
1491         arm64 builds now use the base system LLD 4.0.0 linker by default,
1492         instead of requiring that the aarch64-binutils port or package be
1493         installed. To continue using aarch64-binutils, set
1494         CROSS_BINUTILS_PREFIX=/usr/local/aarch64-freebsd/bin .
1495
1496 20170405:
1497         The UDP optimization in entry 20160818 that added the sysctl
1498         net.inet.udp.require_l2_bcast has been reverted.  L2 broadcast
1499         packets will no longer be treated as L3 broadcast packets.
1500
1501 20170331:
1502         Binds and sends to the loopback addresses, IPv6 and IPv4, will now
1503         use any explicitly assigned loopback address available in the jail
1504         instead of using the first assigned address of the jail.
1505
1506 20170329:
1507         The ctl.ko module no longer implements the iSCSI target frontend:
1508         cfiscsi.ko does instead.
1509
1510         If building cfiscsi.ko as a kernel module, the module can be loaded
1511         via one of the following methods:
1512         - `cfiscsi_load="YES"` in loader.conf(5).
1513         - Add `cfiscsi` to `$kld_list` in rc.conf(5).
1514         - ctladm(8)/ctld(8), when compiled with iSCSI support
1515           (`WITH_ISCSI=yes` in src.conf(5))
1516
1517         Please see cfiscsi(4) for more details.
1518
1519 20170316:
1520         The mmcsd.ko module now additionally depends on geom_flashmap.ko.
1521         Also, mmc.ko and mmcsd.ko need to be a matching pair built from the
1522         same source (previously, the dependency of mmcsd.ko on mmc.ko was
1523         missing, but mmcsd.ko now will refuse to load if it is incompatible
1524         with mmc.ko).
1525
1526 20170315:
1527         The syntax of ipfw(8) named states was changed to avoid ambiguity.
1528         If you have used named states in the firewall rules, you need to modify
1529         them after installworld and before rebooting. Now named states must
1530         be prefixed with colon.
1531
1532 20170311:
1533         The old drm (sys/dev/drm/) drivers for i915 and radeon have been
1534         removed as the userland we provide cannot use them. The KMS version
1535         (sys/dev/drm2) supports the same hardware.
1536
1537 20170302:
1538         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 4.0.0.
1539         Please see the 20141231 entry below for information about prerequisites
1540         and upgrading, if you are not already using clang 3.5.0 or higher.
1541
1542 20170221:
1543         The code that provides support for ZFS .zfs/ directory functionality
1544         has been reimplemented.  It's not possible now to create a snapshot
1545         by mkdir under .zfs/snapshot/.  That should be the only user visible
1546         change.
1547
1548 20170216:
1549         EISA bus support has been removed. The WITH_EISA option is no longer
1550         valid.
1551
1552 20170215:
1553         MCA bus support has been removed.
1554
1555 20170127:
1556         The WITH_LLD_AS_LD / WITHOUT_LLD_AS_LD build knobs have been renamed
1557         WITH_LLD_IS_LD / WITHOUT_LLD_IS_LD, for consistency with CLANG_IS_CC.
1558
1559 20170112:
1560         The EM_MULTIQUEUE kernel configuration option is deprecated now that
1561         the em(4) driver conforms to iflib specifications.
1562
1563 20170109:
1564         The igb(4), em(4) and lem(4) ethernet drivers are now implemented via
1565         IFLIB.  If you have a custom kernel configuration that excludes em(4)
1566         but you use igb(4), you need to re-add em(4) to your custom
1567         configuration.
1568
1569 20161217:
1570         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.1.
1571         Please see the 20141231 entry below for information about prerequisites
1572         and upgrading, if you are not already using clang 3.5.0 or higher.
1573
1574 20161124:
1575         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.0.
1576         Please see the 20141231 entry below for information about prerequisites
1577         and upgrading, if you are not already using clang 3.5.0 or higher.
1578
1579 20161119:
1580         The layout of the pmap structure has changed for powerpc to put the pmap
1581         statistics at the front for all CPU variations.  libkvm(3) and all tools
1582         that link against it need to be recompiled.
1583
1584 20161030:
1585         isl(4) and cyapa(4) drivers now require a new driver,
1586         chromebook_platform(4), to work properly on Chromebook-class hardware.
1587         On other types of hardware the drivers may need to be configured using
1588         device hints.  Please see the corresponding manual pages for details.
1589
1590 20161017:
1591         The urtwn(4) driver was merged into rtwn(4) and now consists of
1592         rtwn(4) main module + rtwn_usb(4) and rtwn_pci(4) bus-specific
1593         parts.
1594         Also, firmware for RTL8188CE was renamed due to possible name
1595         conflict (rtwnrtl8192cU(B) -> rtwnrtl8192cE(B))
1596
1597 20161015:
1598         GNU rcs has been removed from base.  It is available as packages:
1599         - rcs: Latest GPLv3 GNU rcs version.
1600         - rcs57: Copy of the latest version of GNU rcs (GPLv2) before it was
1601         removed from base.
1602
1603 20161008:
1604         Use of the cc_cdg, cc_chd, cc_hd, or cc_vegas congestion control
1605         modules now requires that the kernel configuration contain the
1606         TCP_HHOOK option. (This option is included in the GENERIC kernel.)
1607
1608 20161003:
1609         The WITHOUT_ELFCOPY_AS_OBJCOPY src.conf(5) knob has been retired.
1610         ELF Tool Chain's elfcopy is always installed as /usr/bin/objcopy.
1611
1612 20160924:
1613         Relocatable object files with the extension of .So have been renamed
1614         to use an extension of .pico instead.  The purpose of this change is
1615         to avoid a name clash with shared libraries on case-insensitive file
1616         systems.  On those file systems, foo.So is the same file as foo.so.
1617
1618 20160918:
1619         GNU rcs has been turned off by default.  It can (temporarily) be built
1620         again by adding WITH_RCS knob in src.conf.
1621         Otherwise, GNU rcs is available from packages:
1622         - rcs: Latest GPLv3 GNU rcs version.
1623         - rcs57: Copy of the latest version of GNU rcs (GPLv2) from base.
1624
1625 20160918:
1626         The backup_uses_rcs functionality has been removed from rc.subr.
1627
1628 20160908:
1629         The queue(3) debugging macro, QUEUE_MACRO_DEBUG, has been split into
1630         two separate components, QUEUE_MACRO_DEBUG_TRACE and
1631         QUEUE_MACRO_DEBUG_TRASH.  Define both for the original
1632         QUEUE_MACRO_DEBUG behavior.
1633
1634 20160824:
1635         r304787 changed some ioctl interfaces between the iSCSI userspace
1636         programs and the kernel.  ctladm, ctld, iscsictl, and iscsid must be
1637         rebuilt to work with new kernels.  __FreeBSD_version has been bumped
1638         to 1200005.
1639
1640 20160818:
1641         The UDP receive code has been updated to only treat incoming UDP
1642         packets that were addressed to an L2 broadcast address as L3
1643         broadcast packets.  It is not expected that this will affect any
1644         standards-conforming UDP application.  The new behaviour can be
1645         disabled by setting the sysctl net.inet.udp.require_l2_bcast to
1646         0.
1647
1648 20160818:
1649         Remove the openbsd_poll system call.
1650         __FreeBSD_version has been bumped because of this.
1651
1652 20160708:
1653         The stable/11 branch has been created from head@r302406.
1654
1655 After branch N is created, entries older than the N-2 branch point are removed
1656 from this file. After stable/14 is branched and current becomes FreeBSD 15,
1657 entries older than stable/12 branch point will be removed from current's
1658 UPDATING file.
1659
1660 COMMON ITEMS:
1661
1662         General Notes
1663         -------------
1664         Sometimes, obscure build problems are the result of environment
1665         poisoning.  This can happen because the make utility reads its
1666         environment when searching for values for global variables.  To run
1667         your build attempts in an "environmental clean room", prefix all make
1668         commands with 'env -i '.  See the env(1) manual page for more details.
1669         Occasionally a build failure will occur with "make -j" due to a race
1670         condition.  If this happens try building again without -j, and please
1671         report a bug if it happens consistently.
1672
1673         When upgrading from one major version to another it is generally best to
1674         upgrade to the latest code in the currently installed branch first, then
1675         do an upgrade to the new branch. This is the best-tested upgrade path,
1676         and has the highest probability of being successful.  Please try this
1677         approach if you encounter problems with a major version upgrade.  Since
1678         the stable 4.x branch point, one has generally been able to upgrade from
1679         anywhere in the most recent stable branch to head / current (or even the
1680         last couple of stable branches). See the top of this file when there's
1681         an exception.
1682
1683         The update process will emit an error on an attempt to perform a build
1684         or install from a FreeBSD version below the earliest supported version.
1685         When updating from an older version the update should be performed one
1686         major release at a time, including running `make delete-old` at each
1687         step.
1688
1689         When upgrading a live system, having a root shell around before
1690         installing anything can help undo problems. Not having a root shell
1691         around can lead to problems if pam has changed too much from your
1692         starting point to allow continued authentication after the upgrade.
1693
1694         This file should be read as a log of events. When a later event changes
1695         information of a prior event, the prior event should not be deleted.
1696         Instead, a pointer to the entry with the new information should be
1697         placed in the old entry. Readers of this file should also sanity check
1698         older entries before relying on them blindly. Authors of new entries
1699         should write them with this in mind.
1700
1701         ZFS notes
1702         ---------
1703         When upgrading the boot ZFS pool to a new version (via zpool upgrade),
1704         always follow these three steps:
1705
1706         1) recompile and reinstall the ZFS boot loader and boot block
1707         (this is part of "make buildworld" and "make installworld")
1708
1709         2) update the ZFS boot block on your boot drive (only required when
1710         doing a zpool upgrade):
1711
1712         When booting on x86 via BIOS, use the following to update the ZFS boot
1713         block on the freebsd-boot partition of a GPT partitioned drive ada0:
1714                 gpart bootcode -p /boot/gptzfsboot -i $N ada0
1715         The value $N will typically be 1.  For EFI booting, see EFI notes.
1716
1717         3) zpool upgrade the root pool. New bootblocks will work with old
1718         pools, but not vice versa, so they need to be updated before any
1719         zpool upgrade.
1720
1721         Non-boot pools do not need these updates.
1722
1723         EFI notes
1724         ---------
1725
1726         There are two locations the boot loader can be installed into. The
1727         current location (and the default) is \efi\freebsd\loader.efi and using
1728         efibootmgr(8) to configure it. The old location, that must be used on
1729         deficient systems that don't honor efibootmgr(8) protocols, is the
1730         fallback location of \EFI\BOOT\BOOTxxx.EFI. Generally, you will copy
1731         /boot/loader.efi to this location, but on systems installed a long time
1732         ago the ESP may be too small and /boot/boot1.efi may be needed unless
1733         the ESP has been expanded in the meantime.
1734
1735         Recent systems will have the ESP mounted on /boot/efi, but older ones
1736         may not have it mounted at all, or mounted in a different
1737         location. Older arm SD images with MBR used /boot/msdos as the
1738         mountpoint. The ESP is a MSDOS filesystem.
1739
1740         The EFI boot loader rarely needs to be updated. For ZFS booting,
1741         however, you must update loader.efi before you do 'zpool upgrade' the
1742         root zpool, otherwise the old loader.efi may reject the upgraded zpool
1743         since it does not automatically understand some new features.
1744
1745         See loader.efi(8) and uefi(8) for more details.
1746
1747         To build a kernel
1748         -----------------
1749         If you are updating from a prior version of FreeBSD (even one just
1750         a few days old), you should follow this procedure.  It is the most
1751         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1752
1753         make kernel-toolchain
1754         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1755         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1756
1757         To test a kernel once
1758         ---------------------
1759         If you just want to boot a kernel once (because you are not sure
1760         if it works, or if you want to boot a known bad kernel to provide
1761         debugging information) run
1762         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1763         nextboot -k testkernel
1764
1765         To rebuild everything and install it on the current system.
1766         -----------------------------------------------------------
1767         # Note: sometimes if you are running current you gotta do more than
1768         # is listed here if you are upgrading from a really old current.
1769
1770         <make sure you have good level 0 dumps>
1771         make buildworld
1772         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1773         make installkernel KERNCONF=YOUR_KERNEL_HERE
1774                                                         [1]
1775         <reboot in single user>                         [3]
1776         etcupdate -p                                    [5]
1777         make installworld
1778         etcupdate -B                                    [4]
1779         make delete-old                                 [6]
1780         <reboot>
1781
1782         To cross-install current onto a separate partition
1783         --------------------------------------------------
1784         # In this approach we use a separate partition to hold
1785         # current's root, 'usr', and 'var' directories.   A partition
1786         # holding "/", "/usr" and "/var" should be about 2GB in
1787         # size.
1788
1789         <make sure you have good level 0 dumps>
1790         <boot into -stable>
1791         make buildworld
1792         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1793         <maybe newfs current's root partition>
1794         <mount current's root partition on directory ${CURRENT_ROOT}>
1795         make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
1796         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1797         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1798         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
1799         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1800         <reboot into current>
1801         <do a "native" rebuild/install as described in the previous section>
1802         <maybe install compatibility libraries from ports/misc/compat*>
1803         <reboot>
1804
1805
1806         To upgrade in-place from stable to current
1807         ----------------------------------------------
1808         <make sure you have good level 0 dumps>
1809         make buildworld                                 [9]
1810         make buildkernel KERNCONF=YOUR_KERNEL_HERE      [8]
1811         make installkernel KERNCONF=YOUR_KERNEL_HERE
1812                                                         [1]
1813         <reboot in single user>                         [3]
1814         etcupdate -p                                    [5]
1815         make installworld
1816         etcupdate -B                                    [4]
1817         make delete-old                                 [6]
1818         <reboot>
1819
1820         Make sure that you've read the UPDATING file to understand the
1821         tweaks to various things you need.  At this point in the life
1822         cycle of current, things change often and you are on your own
1823         to cope.  The defaults can also change, so please read ALL of
1824         the UPDATING entries.
1825
1826         Also, if you are tracking -current, you must be subscribed to
1827         freebsd-current@freebsd.org.  Make sure that before you update
1828         your sources that you have read and understood all the recent
1829         messages there.  If in doubt, please track -stable which has
1830         much fewer pitfalls.
1831
1832         [1] If you have third party modules, such as vmware, you should disable
1833         them at this point so they don't crash your system on
1834         reboot. Alternatively, you should rebuild all the modules you have in
1835         your system and install them as well.  If you are running -current, you
1836         should seriously consider placing all sources to all the modules for
1837         your system (or symlinks to them) in /usr/local/sys/modules so this
1838         happens automatically. If all your modules come from ports, then adding
1839         the port origin directories to PORTS_MODULES instead is also automatic
1840         and effective, eg:
1841              PORTS_MODULES+=x11/nvidia-driver
1842
1843         [3] From the bootblocks, boot -s, and then do
1844                 fsck -p
1845                 mount -u /
1846                 mount -a
1847                 sh /etc/rc.d/zfs start  # mount zfs filesystem, if needed
1848                 cd src                  # full path to source
1849                 adjkerntz -i            # if CMOS is wall time
1850         Also, when doing a major release upgrade, it is required that you boot
1851         into single user mode to do the installworld.
1852
1853         [4] Note: This step is non-optional.  Failure to do this step
1854         can result in a significant reduction in the functionality of the
1855         system.  Attempting to do it by hand is not recommended and those
1856         that pursue this avenue should read this file carefully, as well
1857         as the archives of freebsd-current and freebsd-hackers mailing lists
1858         for potential gotchas.  See etcupdate(8) for more information.
1859
1860         [5] Usually this step is a no-op.  However, from time to time
1861         you may need to do this if you get unknown user in the following
1862         step.
1863
1864         [6] This only deletes old files and directories. Old libraries
1865         can be deleted by "make delete-old-libs", but you have to make
1866         sure that no program is using those libraries anymore.
1867
1868         [8] The new kernel must be able to run existing binaries used by an
1869         installworld.  When upgrading across major versions, the new kernel's
1870         configuration must include the correct COMPAT_FREEBSD<n> option for
1871         existing binaries (e.g. COMPAT_FREEBSD11 to run 11.x binaries).  Failure
1872         to do so may leave you with a system that is hard to boot to recover. A
1873         GENERIC kernel will include suitable compatibility options to run
1874         binaries from older branches.  Note that the ability to run binaries
1875         from unsupported branches is not guaranteed.
1876
1877         Make sure that you merge any new devices from GENERIC since the
1878         last time you updated your kernel config file. Options also
1879         change over time, so you may need to adjust your custom kernels
1880         for these as well.
1881
1882         [9] If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1883         "?=" instead of the "=" assignment operator, so that buildworld can
1884         override the CPUTYPE if it needs to.
1885
1886         MAKEOBJDIRPREFIX must be defined in an environment variable, and
1887         not on the command line, or in /etc/make.conf.  buildworld will
1888         warn if it is improperly defined.
1889 FORMAT:
1890
1891 This file contains a list, in reverse chronological order, of major
1892 breakages in tracking -current.  It is not guaranteed to be a complete
1893 list of such breakages, and only contains entries since September 23, 2011.
1894 If you need to see UPDATING entries from before that date, you will need
1895 to fetch an UPDATING file from an older FreeBSD release.
1896
1897 Copyright information:
1898
1899 Copyright 1998-2009 M. Warner Losh <imp@FreeBSD.org>
1900
1901 Redistribution, publication, translation and use, with or without
1902 modification, in full or in part, in any form or format of this
1903 document are permitted without further permission from the author.
1904
1905 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1906 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1907 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1908 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1909 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1910 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1911 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1912 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1913 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1914 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1915 POSSIBILITY OF SUCH DAMAGE.
1916
1917 Contact Warner Losh if you have any questions about your use of
1918 this document.
1919
1920 $FreeBSD$