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