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