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