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