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