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