xref: /freebsd/UPDATING (revision 7e97c6adffde3bd6f60f042ed2603335c005c6a7)
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 15.x IS SLOW:
16	FreeBSD 15.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
3020250903:
31	The BLOAT_KERNEL_WITH_EXTERR kernel config option has been renamed to
32	EXTERR_STRINGS.
33
3420250827:
35	The names of pkg repositories defined in /etc/pkg/FreeBSD.conf have
36	changed: "FreeBSD" is now "FreeBSD-ports", and "FreeBSD-kmods" is now
37	"FreeBSD-ports-kmods".  Users with /usr/local/etc/pkg/repos files
38	which override these will need to adjust their configuration to match
39	the new names.
40
4120250823:
42	The set of pkgbase packages for Kerberos and OpenSSL has changed.
43	After updating past 250e77d4f0a5, you should check 'pkg orphans'
44	and remove any orphaned packages, then examine the output of
45	'pkg install -r base -g FreeBSD-openssl\* FreeBSD-kerberos\*'
46	and install any new packages you need.
47
4820250823:
49	To restore bridge(4)'s ABI compatibility with ifconfig from 14.x or
50	earlier, the size of struct ifbreq has changed, so you must update
51	the kernel and /sbin/ifconfig at the same time or you will not be
52	able to add interfaces to bridge.  This is particularly important
53	if you require bridge for network access during boot, in which case
54	you should install the new kernel and the new /sbin/ifconfig prior
55	to rebooting.
56
5720250820:
58	The WITHOUT_GSSAPI src.conf knob has been removed.  This was already
59	a no-op for MIT Kerberos, so this only affects builds which set
60	WITHOUT_MITKRB5=1, in which case you now always get libgssapi.
61
62	Also, Heimdal's compile_et and libcom_err are now controlled by
63	WITHOUT_KERBEROS, not WITHOUT_KERBEROS_SUPPORT.  This matches
64	the behaviour of the MIT Kerberos versions.
65
6620250820:
67	Commits 08c7dd2fbe4f and a4197ea47777 have changed the ABI between
68	libvmmapi and the vmm device. If using a custom kernel configuration,
69	please ensure that the COMPAT_FREEBSD14 option is included so older
70	versions of libvmmapi continue working as expected.
71
7220250819:
73	The CLEAN option has been switched back from default-on to default-off.
74	This reverts the 20250808 change below, which had reverted the 20240729
75	change before it.  Note that some src.conf(5) options are known to break
76	ABI or compatibility in ways that may require a clean build initially
77	when switched.
78
7920250816:
80	Sendmail's libmilter has been moved to its own package.  If you want
81	to compile applications that use libmilter, you should install the
82	FreeBSD-libmilter* packages.
83
84	If you only have FreeBSD-sendmail installed for applications that
85	require libmilter, you can now remove it.
86
8720250815:
88	The [gs]etgroups(2)syscalls have changed. To maintain backwards
89	compatibility with existing programs, you need COMPAT_FREEBSD14 in
90	your kernel config until all applications which use this are
91	rebuild/reinstalled.
92
9320250815:
94	jemalloc 5.3.0 has been committed to the tree.
95
9620250815:
97	The removal of Secure RPC DES authentication noted in 20250810
98	has been reverted.  (However, it is still non-functional.)
99
10020250813:
101	Commit cce64f2e6851 changed the internal KAPI between the NFS
102	modules.  As such, all of them need to be rebuilt from sources.
103	__FreeBSD_version has been bumped to 1500060 already today,
104	 so I will not bump it again for this.
105
10620250813:
107	The gpiobus_attach_bus() function has been removed. Drivers should now
108	use the gpiobus_add_bus() function instead. The difference being that
109	gpiobus_add_bus() doesn't call bus_attach_children(), calling it will
110	be the responsibility of the caller now.
111
11220250810:
113	Support for Secure RPC DES authentication has been removed.
114	The keyserv(8) daemon was already removed, but support for it in libc
115	has also been removed, so if you somehow still had keyserv installed,
116	it will now stop working.  There is no workaround for this.  Removing
117	DES is considered a feature.
118
11920250808:
120	The CLEAN option has been switched back from default-off to
121	default-on.  This reverts the 20240729 change below.
122
12320250807:
124	routed(8) and route6d(8) have moved to the FreeBSD-rip package.
125	If you use either of these, you should install the new package.
126
12720250806:
128	if_epair(4) now uses ether_gen_addr(9) to generate a stable MAC
129	address.
130	To keep using the random address, set the loader tunable
131	net.link.epair.ether_gen_addr=0.
132
13320250804:
134	bsdconfig (including sysrc(8)) has moved to the new bsdconfig
135	package.  If you use pkgbase and wish to use bsdconfig, you should
136	install FreeBSD-bsdconfig.
137
13820250730:
139	The usbhid(4) USB HID driver is now enabled by default, and will be
140	used in preference to other USB HID drivers like ukbd(4), ums(4), and
141	uhid(4).  Work on a FIDO/U2F driver and moused(8) is in progress.
142	The default is being switched now so that we can find and fix any
143	additional issues prior to FreeBSD 15.0.
144
145	To revert to the previous USB HID driver behavior, set the loader
146	tunable hw.usb.usbhid.enable=0.
147
14820250727:
149	bmake (i.e., /usr/bin/make and /usr/share/mk) has moved to a new
150	package, FreeBSD-bmake.  If you use pkgbase and you need make, you
151	should install this package.
152
15320250726:
154	amd64 kernel configurations must contain "options SMP".
155
15620250725:
157	gssd(8) has been moved to a new package, FreeBSD-gssd.  If you use
158	pkgbase and you need gssd, you should install this package.
159
16020250724:
161	The Kerberos packages which are built when WITH_MITKRB5 is enabled
162	have been renamed from FreeBSD-krb5* to FreeBSD-kerberos*.  This
163	affects pkgbase users who manually enabled WITH_MITKRB5, *or* use
164	the default value of WITH_MITKRB5 and updated past c7da9fb90b0b
165	(20250721) which made WITH_MITKRB5 the default.
166
167	In either case, if you have FreeBSD-krb5* packages installed, you
168	should remove them and (re)install the equivalent FreeBSD-kerberos*
169	packages instead.
170
17120250721:
172	WITH_MITKRB5 is now enabled by default. MIT KRB5 has replaced
173	Heimdal in base. Ports that use USES=gssapi must be rebuilt.
174	A clean buildworld is required.
175
17620250719:
177	Commits 392a82b225 and c00baac0ab both changed the
178	internal API between the NFS modules.  As such, all
179	these modules need to be rebuilt from sources.
180	__FreeBSD_version was bumped to 1500053 for this.
181
18220250710:
183	The shar(1) utility has been removed from base.  The
184	sysutils/freebsd-shar port was created to maintain this version of
185	shar(1) past its removal from base.
186
18720250704:
188	LinuxKPI device.h and acpi changes effecting drivers and drm-kmod.
189	Bump __FreeBSD_version 1500050 to be able to detect these changes.
190
19120250630:
192	Commits 171f66b0c2ca and 8e2a90ac8089 changed the internal
193	api between nfscommon.ko and the other nfs modules.
194	Bump __FreeBSD_version to 1500049 for this.
195	All NFS related modules must be rebuilt from up-to-date
196	sources.
197
19820250625:
199	"make delete-old" will now remove the Forth bootloader entirely
200	if the system is built with WITHOUT_FORTH.
201
20220250614:
203	MIT KRB5 (MIT Kerberos5) has been imported into 15-CURRENT. To
204	and install MIT KRB5, add WITH_MITKRB5=yes to /etc/src.conf. This
205	will build and install MIT KRB5 1.21.3. And it will remove Heimdal
206	1.5.2 when delete-old and delete-old-libs are run. To revert back
207	simply buildworld/installworld again with delete-old-libs and
208	delete-old.
209
210	At the moment we only know of a couple of ports that might be
211	affected. Adjusting libmap.conf does not circumvent runtime issues.
212	The few affected ports must be rebuilt. A successful exp-run will be
213	run before MIT KRB5 becomes default.
214
215	Those using the KDC in FreeBSD base may wish to wait. The Heimdal
216	HDB is incompatible with the MIT KRB5 KDC. The migration procedure
217	is a little involved.
218
21920250603:
220	LinuxKPI dma-mapping.h were pulled into the tree from drm-kmod.
221	Bump _FreeBSD_version to 1500045 to be able to detect this change.
222
22320250527:
224	pf changed extension header handling. It now treats AH headers on IPv4 just
225	like AH headers on IPv6 and skips over them, allowing filtering on the inner
226	protocol.
227
22820250527:
229	pf now blocks IPv6 packets with a hop-by-hop or destination options header by
230	default. Such packets can be passed by adding "allow-opts" to the rule. IPv6
231	options are now handled just like their IPv4 counterparts.
232
23320250527:
234	The CAM target layer userland, i.e. ctld(8), ctladm(8) and ctlstat(8),
235	has moved to the new FreeBSD-ctl package.  If you use pkgbase and you
236	need the CAM Target Layer, you should install the new package.
237
238	Development-related tools (e.g. ar and nm) have moved to the new
239	"FreeBSD-toolchain" package, which subsumes and obsoletes the
240	existing "FreeBSD-elftoolchain" package.  If you use pkgbase and
241	need to compile software, you should install the new package and
242	ensure the old FreeBSD-elftoolchain* packages are completely removed.
243
24420250521:
245	Commit e64fe5ad3a23 removed in6_maxmtu and its setter in6_setmaxmtu().
246	in6_maxmtu is used to store the max IPv6 MTU of all interfaces,
247	however it does not have any in-tree consumers since the introduction
248	from the KAME project. The removal should have little impact, and the
249	max IPv6 MTU can be easily retrieved by iterating over all the attached
250	interface if 3rd party modules need it.
251
25220250515:
253	Commit 772258c89f28 changed the internal API between the nfscommon
254	and nfscl modules.  Both need to be built from updated sources.
255
25620250513:
257	The bridge(4) sysctl net.link.bridge.member_ifaddrs now defaults to 0,
258	meaning that interfaces added to a bridge may not have IP addresses
259	assigned.  Refer to bridge(4) for more information.
260
26120250507:
262	UMASS quirks and auto-quirk probing has been overhauled. CAM now won't
263	send SYNCHRONIZE CACHE unless MODE PAGE 8 is present and valid. This
264	should allow more devices to work (since the auto quirk code was updated
265	in 14 and broke several e-readers and the like). Please send imp@freebsd.org
266	any regression reports.
267
26820250504:
269	Commit 9419e086e1a3 changed the internal API between the nfscommon
270	and nfscl modules.  Both need to be built from updated sources.
271
27220250412:
273	LinuxKPI alloc routines were changed to return physically contiguous
274	memory where expected. These changes may require out-of-tree drivers
275	to be recompiled.
276	Bump __FreeBSD_version to 1500037 to be able to detect this change.
277
27820250409:
279	Intel iwlwifi firmware has been removed from the src repository.
280	Before updating their system, users of iwlwifi(4) or iwx(4) must
281	install the appropriate firmware for their chipset using fwget(8) or
282	building it from ports.
283
28420250314:
285	We now use LLVM's binary utilities (nm, objcopy, etc.) by default.
286	The WITHOUT_LLVM_BINUTILS src.conf(5) knob can be used to revert to
287	ELF Tool Chain tools if desired.
288
28920250303:
290	Commit 4a77657cbc01 changed the ABI between ipfw(8) and ipfw(4).
291	Please note that the old ipfw(8) binary will not work with the new
292	ipfw(4) module. Therefore, it is recommended to disable ipfw during
293	the upgrade, otherwise the host system may become inaccessible because
294	ipfw rules cannot be installed with the old binary.
295
29620250214:
297	Commit 4517fbfd4251 modified the internal API between the
298	nfscommon and nfscl modules.  As such, both of these modules
299	need to be rebuilt from sources.
300
30120250201:
302	The NFS related daemons, that provide RPC services to the kernel:
303	gssd(8), rpcbind(8), rpc.tlsservd(8) and rpc.tlsclntd(8), now use a
304	different transport - netlink(4) socket instead of unix(4).  Users of
305	NFS need to upgrade both kernel and world (binaries and libc) at once.
306	Also, any revision between 88cd1e17a7d8 and 99e5a70046da should be
307	avoided.
308
30920250129:
310	Defer the January 19, 2038 date limit in UFS1 filesystems to
311	February 7, 2106. This affects only UFS1 format filesystems.
312	See commit message 1111a44301da for details.
313
31420250127:
315	The Allwinner a10_timer driver has been renamed to aw_driver. If you
316	have a custom kernel configuration including the line 'device
317	a10_timer', it must be adjusted to 'device aw_timer'. The same applies
318	for device exclusions with 'nodevice'.
319
32020250106:
321	A new SOC_ROCKCHIP options appeared, so if you have a custom kernel configuration
322	targetting Rockchip SoC you need to add it so shared and mandatory drivers for
323	this SoC familly will be selected.
324	Also a new rk8xx device was added, this select the base driver for Rockchip PMIC.
325
32620241223:
327	The layout of NFS file handles for the tarfs, tmpfs, cd9660, and ext2fs
328	file systems has changed.  An NFS server that exports any of these file
329	systems will need its clients to unmount and remount the exports.
330
33120241216:
332	The iwm(4) firmwares are no longer compiled as kernel modules but instead
333	shipped as raw files. For pkgbase users if you use iwm(4) you will need
334	to install the FreeBSD-firmware-iwm package.
335
33620241124:
337	The OpenBSD derived bc and dc implementations and the WITHOUT_GH_BC
338	option that allowed building them instead of the advanced version
339	imported more than 4 years ago have been removed.
340
34120241107:
342	The ng_ubt(4) driver now requires firmwares to be loaded on Realtek
343	adaptors with rtlbtfw(8) utility. It no longer attaches to devices
344	standing in bootloader mode. Firmware files are available in the
345	comms/rtlbt-firmware port.
346
34720241025:
348	The support for the rc_fast_and_loose variable has been removed from
349	rc.subr(8). Users setting rc_fast_and_loose on their systems are
350	advised to make sure their customizations to rc service scripts
351	do not depend on having a single shell environment shared across
352	all the rc service scripts during booting and shutdown.
353
35420241013:
355	The ciss driver was updated to cope better with hotplug events that
356	caused it to panic before, and to support more than 48 drives attached
357	to the card. These changes were made w/o benefit of hardware for testing
358	and ciss(4) users should be on the lookout for regressions.
359
36020240729:
361	The build now defaults to WITHOUT_CLEAN - i.e., no automatic clean
362	is performed at the beginning of buildworld or buildkernel.  The
363	WITH_CLEAN src.conf(5) knob can be used to restore the previous
364	behaviour.
365
366	If you encounter incremental build issues, please report them to the
367	freebsd-current mailing list so that a special-case dependency can be
368	added, if necessary.
369
37020240715:
371	We now lean more heavily on ACPI enumeration for some traditional
372	devices. uart has moved from isa to acpi so the hints act as wiring
373	instead of device enumeration. Hints for parallel port, floppy, etc
374	have been removed.  Before upgrading, grep your dmesg for lines like:
375		uart1: non-PNP ISA device will be removed from GENERIC in FreeBSD 15.
376	to see if you need to start including hints for the device on isa
377	in your loader.conf or device.hints file. APU1 (but not APU2) boards
378	are known to be affected, but there may be others.
379
38020240712:
381	Support for armv6 has been disconnected and is being removed.
382
38320240617:
384	ifconfig now treats IPv4 addresses without a width or mask as an error.
385	Specify the desired mask or width along with the IP address on the
386	ifconfig command line and in rc.conf.
387
38820240428:
389	OpenBSM auditing runtime (auditd, etc.) has been moved into the new
390	package FreeBSD-audit.  If you use OpenBSM auditing and pkgbase, you
391	should install FreeBSD-audit.
392
39320240424:
394	cron, lpr, and ntpd have been moved from FreeBSD-utilities into their
395	own packages.  If you use pkgbase, you should install the relevant
396	packages: FreeBSD-cron, FreeBSD-lp, or FreeBSD-ntp.
397
39820240406:
399	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
400	been upgraded to 18.1.6. It is important that you run `make delete-old`
401	as described in the COMMON ITEMS section, otherwise several libc++
402	headers that are obsolete and need to be removed can cause compilation
403	errors in C++ programs.
404
40520240205:
406	For dynamically linked programs, system calls are now made from
407	libsys rather than libc.  No change in linkage is required as
408	libsys is an auxiliary filter for libc.  People building custom
409	images must ensure that libsys.so.7 is included.
410
41120240202:
412	Loader now also read configuration files listed in local_loader_conf_files.
413	Files listed here are the last ones read. And /boot/loader.conf.local was
414	moved from loader_conf_files to local_loader_conf_files leaving only
415	loader.conf and device.hints in loader_conf_files by default.
416
417	The following sequencing is applied:
418
419	1. Bootstrap:
420	    /boot/defaults/loader.conf
421
422	2. Read loader_conf_files files:
423	    /boot/device.hints
424	    /boot/loader.conf
425
426	3. Read loader_conf_dirs files:
427	    /boot/loader.conf.d/*.conf
428
429	4. And finally, rread local_loader_conf_files files:
430	    /boot/loader.conf.local
431
43220240201:
433	sendmail 8.18.1 has been imported and merged.  This version enforces
434	stricter RFC compliance by default, especially with respect to line
435	endings.  This may cause issues with receiving messages from
436	non-compliant MTAs; please see the first 8.18.1 release note in
437	contrib/sendmail/RELEASE_NOTES for mitigations.
438
43920240111:
440	Commit cc760de2183f changed the internal interface between
441	the nfscommon and nfscl modules.  As such, both need to be
442	rebuilt from sources.  Therefore, __FreeBSD_version was
443	bumped to 1500010.
444
44520231120:
446	If you have an arm64 system that uses ACPI, you will need to update your
447	loader.efi in the ESP when you update past this point.  Detection of ACPI
448	was moved earlier in the binary so the scripts could use it, but old
449	binaries don't have this, so we default to 'no ACPI' in this case. You can
450	undisable ACPI by doing
451		OK unset hint.acpi.0.disabled
452	This can also be used to recover any other system that was updated in the
453	small window where amd64 was also broken.
454
45520231113:
456	The WITHOUT_LLD_IS_LD option has been removed.  When LLD is enabled
457	it is always installed as /usr/bin/ld.
458
45920231027:
460	Forward compatibility (running the new code on old kernels) for the
461	"ino64" project have been removed. The need for it has passed long ago.
462
46320231018:
464	Commit 57ce37f9dcd0 changed the internal KAPI between the
465	nfscommon and nfscl modules.  Both must be rebuilt from sources.
466
46720231010:
468	dialog(1) has been replaced in base by bsddialog(1), while most of the
469	time replacing a dialog(1) call by a bsddialog(1) call works out of the
470	box, bsddialog(1) is not considered as a drop-in replacement for
471	dialog(1).
472
473	If you do depend on dialog(1) functionality, please install cdialog
474	from ports:
475
476	pkg install cdialog
477
47820230927:
479	The EARLY_AP_STARTUP kernel option is mandatory on x86.  The option
480	has been added to DEFAULTS, so it should automatically be included in
481	custom kernel configurations without any additional change.
482
48320230922:
484	A new loader tunable net.pf.default_to_drop allows pf(4)’s default
485	behaviour to be changed from pass to drop. Previously this required
486	recompiling the kernel with the option PF_DEFAULT_TO_DROP.
487
48820230914:
489	Enable splitting out pkgbase manpages into separate packages by
490	default. To disable this, set WITHOUT_MANSPLITPKG=yes in src.conf.
491
49220230911:
493	Move standard include files to the clibs-dev package and move clang
494	internal libraries and headers to clang and clang-dev. Upgrading systems
495	installed using pkgbase past this change involves extra steps to allow
496	for these file moves:
497
498		pkg upgrade -y FreeBSD-utilities
499		pkg upgrade -y FreeBSD-utilities-dev
500		pkg upgrade -y
501
50220230909:
503	Enable vnet sysctl variables to be loader tunable. SYSCTLs which
504	belongs to VNETs can be initialized during early boot or module
505	loading if they are marked with CTLFLAG_TUN and there are
506	corresponding kernel environment variables.
507
50820230901:
509	The WITH_INIT_ALL_PATTERN and WITH_INIT_ALL_ZERO build options have
510	been replaced by INIT_ALL=pattern and INIT_ALL=zero respectively.
511
51220230824:
513	FreeBSD 15.0-CURRENT.
514
51520230817:
516	Serial communication (in boot loaders, kernel, and userland) has
517	been changed to default to 115200 bps, in line with common industry
518	practice and typcial firmware serial console redirection
519	configuration.
520
521	Note that the early x86 BIOS bootloader (i.e., boot0sio) does not
522	support rates above 9600 bps and is not changed. boot0sio users may
523	set BOOT_COMCONSOLE_SPEED=9600 to use 9600 for all of the boot
524	components, or use the standard boot0 and have the boot2 stage start
525	with the serial port at 115200.
526
52720230807:
528	Following the general removal of MIPS support, the ath(4) AHB bus-
529	frontend has been removed, too, and building of the PCI support is
530	integrated with the ath(4) main module again. As a result, there's
531	no longer a need for if_ath_pci_load="YES" in /boot/loader.conf or
532	"device ath_pci" in the kernel configuration.
533
53420230803:
535	MAXCPU has been increased to 1024 in the amd64 GENERIC kernel config.
536	Out-of-tree kernel modules will need to be rebuilt.
537
53820230724:
539	CAM has been mechanically updated s/u_int(64|32|16|8)_t/uint\1_t/g
540	to move to the standard uintXX_t types from the old, traditional
541	BSD u_intXX_t types. This should be a NOP, but may cause problems
542	for out of tree changes. The SIMs were not updated since most of
543	the old u_intXX_t uses weren't due to CAM interfaces.
544
54520230713:
546	stable/14 branch created.
547
54820230629:
549	The heuristic for detecting old chromebooks with an EC bug that requires
550	atkbdc driver workarounds has changed. There should be no functional
551	change, but if your old chromebook's keyboard stops working, please
552	file a PR and assign it to imp.
553
55420230623:
555	OpenSSL has been updated to version 3.0, including changes throughout
556	the base system.  It is important to rebuild third-party software
557	after upgrading.
558
55920230619:
560	To enable pf rdr rules for connections initiated from the host, pf
561	filter rules can be optionally enabled for packets delivered
562	locally. This can change the behavior of rules which match packets
563	delivered to lo0. To enable this feature:
564
565		sysctl net.pf.filter_local=1
566		service pf restart
567
568	When enabled, its best to ensure that packets delivered locally are not
569	filtered, e.g. by adding a 'skip on lo' rule.
570
57120230613:
572	Improvements to libtacplus(8) mean that tacplus.conf(5) now
573	follows POSIX shell syntax rules. This may cause TACACS+
574	authentication to fail if the shared secret contains a single
575	quote, double quote, or backslash character which isn't
576	already properly quoted or escaped.
577
57820230612:
579	Belatedly switch the default nvme block device on x86 from nvd to nda.
580	nda created nvd compatibility links by default, so this should be a
581	nop. If this causes problems for your application, set hw.nvme.use_nvd=1
582	in your loader.conf or add `options NVME_USE_NVD=1` to your kernel
583	config. To disable the nvd compatibility aliases, add
584	kern.cam.nda.nvd_compat=0 to loader.conf.  The default has been nda on
585	all non-x86 platforms for some time now. If you need to fall back,
586	please email imp@freebsd.org about why.
587
588	Encrypted swap partitions need to be changed from nvd to nda if you
589	migrate, or you need to use the above to switch back to nvd.
590
59120230422:
592	Remove portsnap(8).  Users are encouraged to obtain the ports tree
593	using git instead.
594
59520230420:
596	Add jobs.mk to save typing. Enables -j${JOB_MAX} and logging
597	eg.
598		make buildworld-jobs
599	runs
600		make -j${JOB_MAX} buildworld > ../buildworld.log 2>&1
601
602	where JOB_MAX is derrived from ncpus in local.sys.mk if not set in env.
603
60420230316:
605	Video related devices for some arm devices have been renamed.
606	If you have a custom kernel config and want to use hdmi output on
607	IMX6 board you need to add "device dwc_hdmi" "device imx6_hdmi" and
608	"device imx6_ipu" to it.
609	If you have a custom kernel config and want to use hdmi output on
610	TI AM335X board you need to add "device tda19988" to it.
611	If you add "device hdmi" in it you need to remove it as it doesn't
612	exist anymore.
613
61420230221:
615	Introduce new kernel options KBD_DELAY1 and KBD_DELAY2. See atkbdc(4)
616	for details.
617
61820230206:
619	sshd now defaults to having X11Forwarding disabled, following upstream.
620	Administrators who wish to enable X11Forwarding should add
621	`X11Forwarding yes` to /etc/ssh/sshd_config.
622
62320230204:
624	Since commit 75d41cb6967 Huawei 3G/4G LTE Mobile Devices do not default
625	to ECM, but NCM mode and need u3g and ucom modules loaded. See cdce(4).
626
62720230130:
628	As of commit 7c40e2d5f685, the dependency on netlink(4) has been added
629	to the linux_common(4) module. Users relying on linux_common may need
630	to complile netlink(4) module if it is not present in their kernel.
631
63220230126:
633	The WITHOUT_CXX option has been removed. C++ components in the base
634	system are now built unconditionally.
635
63620230113:
637	LinuxKPI pci.h changes may require out-of-tree drivers to be recompiled.
638	Bump _FreeBSD_version to 1400078 to be able to detect this change.
639
64020221212:
641	llvm-objump is now always installed as objdump.  Previously there was
642	no /usr/bin/objdump unless the WITH_LLVM_BINUTILS knob was used.
643
644	Some LLVM objdump options have a different output format compared to
645	GNU objdump; readelf is available for inspecting ELF files, and GNU
646	objdump is available from the devel/binutils port or package.
647
64820221205:
649	dma(8) has replaced sendmail(8) as the default mta.  For people willing
650	to reenable sendmail(8):
651
652	$ cp /usr/share/examples/sendmail/mailer.conf /etc/mail/mailer.conf
653
654	and add sendmail_enable="YES" to rc.conf.
655
65620221204:
657	hw.bus.disable_failed_devices has changed from 'false' to 'true' by
658	default. Now if newbus succeeds in probing a device, but fails to attach
659	the device, we'll disable the device. In the past, we'd keep retrying
660	the device on each new driver loaded. To get that behavior now, one
661	needs to use devctl to re-enable the device, and reprobe it (or set
662	the sysctl/tunable hw.bus.disable_failed_devices=false).
663
664	NOTE: This was reverted 20221205 due to unexpected compatibility issues
665
66620221122:
667	pf no longer accepts 'scrub fragment crop' or 'scrub fragment drop-ovl'.
668	These configurations are no longer automatically reinterpreted as
669	'scrub fragment reassemble'.
670
67120221121:
672	The WITHOUT_CLANG_IS_CC option has been removed.  When Clang is enabled
673	it is always installed as /usr/bin/cc (and c++, cpp).
674
67520221026:
676	Some programs have been moved into separate packages. It is recommended
677	for pkgbase users to do:
678
679	pkg install FreeBSD-dhclient FreeBSD-geom FreeBSD-resolvconf \
680	  FreeBSD-devd FreeBSD-devmatch
681
682	after upgrading to restore all the component that were previously
683	installed.
684
68520221002:
686	OPIE has been removed from the base system.  If needed, it can
687	be installed from ports (security/opie) or packages (opie).
688	Otherwise, make sure that your PAM policies do not reference
689	pam_opie or pam_opieaccess.
690
69120220610:
692	LinuxKPI pm.h changes require an update to the latest drm-kmod version
693	before re-compiling to avoid errors.
694
69520211230:
696	The macros provided for the manipulation of CPU sets (e.g. CPU_AND)
697	have been modified to take 2 source arguments instead of only 1.
698	Externally maintained sources that use these macros will have to
699	be adapted. The FreeBSD version has been bumped to 1400046 to
700	reflect this change.
701
70220211214:
703	A number of the kernel include files are able to be included by
704	themselves.  A test has been added to buildworld to enforce this.
705
70620211209:
707	Remove mips as a recognized target. This starts the decommissioning of
708	mips support in FreeBSD. mips related items will be removed wholesale in
709	the coming days and weeks.
710
711	This broke the NO_CLEAN build for some people. Either do a clean build
712	or touch
713		lib/clang/include/llvm/Config/Targets.def
714		lib/clang/include/llvm/Config/AsmParsers.def
715		lib/clang/include/llvm/Config/Disassemblers.def
716		lib/clang/include/llvm/Config/AsmPrinters.def
717	before the build to force everything to rebuild that needs to.
718
71920211202:
720	Unbound support for RFC8375: The special-use domain 'home.arpa' is
721	by default blocked. To unblock it use a local-zone nodefault
722	statement in unbound.conf:
723		local-zone: "home.arpa." nodefault
724
725	Or use another type of local-zone to override with your choice.
726
727	The reason for this is discussed in Section 6.1 of RFC8375:
728	Because 'home.arpa.' is not globally scoped and cannot be secured
729	using DNSSEC based on the root domain's trust anchor, there is no way
730	to tell, using a standard DNS query, in which homenet scope an answer
731	belongs.  Consequently, users may experience surprising results with
732	such names when roaming to different homenets.
733
73420211110:
735	Commit b8d60729deef changed the TCP congestion control framework so
736	that any of the included congestion control modules could be
737	the single module built into the kernel. Previously newreno
738	was automatically built in through direct reference. As of
739	this commit you are required to declare at least one congestion
740	control module (e.g. 'options CC_NEWRENO') and to also declare a
741	default using the CC_DEFAULT option (e.g. options CC_DEFAULT="newreno\").
742	The GENERIC configuration includes CC_NEWRENO and defines newreno
743	as the default. If no congestion control option is built into the
744	kernel and you are including networking, the kernel compile will
745	fail. Also if no default is declared the kernel compile will fail.
746
74720211118:
748	Mips has been removed from universe builds. It will be removed from the
749	tree shortly.
750
75120211106:
752	Commit f0c9847a6c47 changed the arguments for VOP_ALLOCATE.
753	The NFS modules must be rebuilt from sources and any out
754	of tree file systems that implement their own VOP_ALLOCATE
755	may need to be modified.
756
75720211022:
758	The synchronous PPP kernel driver sppp(4) has been removed.
759	The cp(4) and ce(4) drivers are now always compiled with netgraph(4)
760	support, formerly enabled by NETGRAPH_CRONYX option.
761
76220211020:
763	sh(1) is now the default shell for the root user.  To force root to use
764	the csh shell, please run the following command as root:
765
766	# chsh -s csh
767
76820211004:
769	Ncurses distribution has been split between libtinfow and libncurses
770	with libncurses.so becoming a linker (ld) script to seamlessly link
771	to libtinfow as needed. Bump _FreeBSD_version to 1400035 to reflect
772	this change.
773
77420210923:
775	As of commit 8160a0f62be6, the dummynet module no longer depends on the
776	ipfw module. Dummynet can now be used by pf as well as ipfw. As such
777	users who relied on this dependency may need to include ipfw in the
778	list of modules to load on their systems.
779
78020210922:
781	As of commit 903873ce1560, the mixer(8) utility has got a slightly
782	new syntax. Please refer to the mixer(8) manual page for more
783	information. The old mixer utility can be installed from ports:
784	audio/freebsd-13-mixer
785
78620210911:
787	As of commit 55089ef4f8bb, the global variable nfs_maxcopyrange has
788	been deleted from the nfscommon.ko.  As such, nfsd.ko must be built
789	from up to date sources to avoid an undefined reference when
790	being loaded.
791
79220210817:
793	As of commit 62ca9fc1ad56 OpenSSL no longer enables kernel TLS
794	by default.  Users can enable kernel TLS via the "KTLS" SSL
795	option.  This can be enabled globally by using a custom
796	OpenSSL config file via OPENSSL_CONF or via an
797	application-specific configuration option for applications
798	which permit setting SSL options via SSL_CONF_cmd(3).
799
80020210811:
801	Commit 3ad1e1c1ce20 changed the internal KAPI between the NFS
802	modules. Therefore, all need to be rebuilt from sources.
803
80420210730:
805	Commit b69019c14cd8 removes pf's DIOCGETSTATESNV ioctl.
806	As of be70c7a50d32 it is no longer used by userspace, but it does mean
807	users may not be able to enumerate pf states if they update the kernel
808	past b69019c14cd8 without first updating userspace past be70c7a50d32.
809
81020210729:
811	As of commit 01ad0c007964 if_bridge member interfaces can no longer
812	change their MTU. Changing the MTU of the bridge itself will change the
813	MTU on all member interfaces instead.
814
81520210716:
816	Commit ee29e6f31111 changed the internal KAPI between the nfscommon
817	and nfsd modules. Therefore, both need to be rebuilt from sources.
818	Bump __FreeBSD_version to 1400026 for this KAPI change.
819
82020210715:
821	The 20210707 awk update brought in a change in behavior. This has
822	been corrected as of d4d252c49976. Between these dates, if you
823	installed a new awk binary, you may not be able to build a new
824	kernel because the change in behavior affected the genoffset
825	script used to build the kernel. If you did update, the fix is
826	to update your sources past the above hash and do
827		% cd usr.bin/awk
828		% make clean all
829		% sudo -E make install
830	to enable building kernels again.
831
83220210708:
833	Commit 1e0a518d6548 changed the internal KAPI between the NFS
834	modules. They all need to be rebuilt from sources.  I did not
835	bump __FreeBSD_version, since it was bumped recently.
836
83720210707:
838	awk has been updated to the latest one-true-awk version 20210215.
839	This contains a number of minor bug fixes.
840
84120210624:
842	The NFSv4 client now uses the highest minor version of NFSv4
843	supported by the NFSv4 server by default instead of minor version 0,
844	for NFSv4 mounts.
845	The "minorversion" mount option may be used to override this default.
846
84720210618:
848	Bump __FreeBSD_version to 1400024 for LinuxKPI changes.
849	Most notably netdev.h can change now as the (last) dependencies
850	(mlx4/ofed) are now using struct ifnet directly, but also for PCI
851	additions and others.
852
85320210618:
854	The directory "blacklisted" under /usr/share/certs/ has been
855	renamed to "untrusted".
856
85720210611:
858	svnlite has been removed from base. Should you need svn for any reason
859	please install the svn package or port.
860
86120210611:
862	Commit e1a907a25cfa changed the internal KAPI between the krpc
863	and nfsserver.  As such, both modules must be rebuilt from
864	sources.  Bump __FreeBSD_version to 1400022.
865
86620210610:
867	The an(4) driver has been removed from FreeBSD.
868
86920210608:
870	The vendor/openzfs branch was renamed to vendor/openzfs/legacy to
871	start tracking OpenZFS upstream more closely. Please see
872https://lists.freebsd.org/archives/freebsd-current/2021-June/000153.html
873	for details on how to correct any errors that might result. The
874	short version is that you need to remove the old branch locally:
875	    git update-ref -d refs/remotes/freebsd/vendor/openzfs
876	(assuming your upstream origin is named 'freebsd').
877
87820210525:
879	Commits 17accc08ae15 and de102f870501 add new files to LinuxKPI
880	which break drm-kmod.  In addition various other additions where
881	committed. Bump __FreeBSD_version to 1400015 to be able to
882	detect this.
883
88420210513:
885	Commit ca179c4d74f2 changed the package in which the OpenSSL
886	libraries and utilities are packaged.
887	It is recommended for pkgbase user to do:
888	pkg install -f FreeBSD-openssl
889	before pkg upgrade otherwise some dependencies might not be met
890	and pkg will stop working as libssl will not be present anymore
891	on the system.
892
89320210426:
894	Commit 875977314881 changed the internal KAPI between
895	the nfsd and nfscommon modules.  As such these modules
896	need to be rebuilt from sources.
897	Without this patch in your NFSv4.1/4.2 server, enabling
898	delegations by setting vfs.nfsd.issue_delegations non-zero
899	is not recommended.
900
90120210411:
902	Commit 7763814fc9c2 changed the internal KAPI between
903	the krpc and NFS.  As such, the krpc, nfscommon and
904	nfscl modules must all be rebuilt from sources.
905	Without this patch, NFSv4.1/4.2 mounts should not
906	be done with the nfscbd(8) daemon running, to avoid
907	needing a working back channel for server->client RPCs.
908
90920210330:
910	Commit 01ae8969a9ee fixed the NFSv4.1/4.2 server so that it
911	handles binding of the back channel as required by RFC5661.
912	Until this patch is in your server, avoid use of the "nconnects"
913	mount option for Linux NFSv4.1/4.2 mounts.
914
91520210225:
916	For 64-bit architectures the base system is now built with Position
917	Independent Executable (PIE) support enabled by default.  It may be
918	disabled using the WITHOUT_PIE knob.  A clean build is required.
919
92020210128:
921	Various LinuxKPI functionality was added which conflicts with DRM.
922	Please update your drm-kmod port to after the __FreeBSD_version 1400003
923	update.
924
92520210121:
926	stable/13 branch created.
927
92820210108:
929	PC Card attachments for all devices have been removed. In the case of
930	wi and cmx, the entire drivers were removed because they were only
931	PC Card devices. FreeBSD_version 1300134 should be used for this
932	since it was bumped so recently.
933
93420210107:
935	Transport-independent parts of HID support have been split off the USB
936	code in to separate subsystem.  Kernel configs which include one of
937	ums, ukbd, uhid, atp, wsp, wmt, uaudio, ugold or ucycom drivers should
938	be updated with adding of "device hid" line.
939
94020210105:
941	ncurses installation has been modified to only keep the widechar
942	enabled version.  Incremental build is broken for that change, so it
943	requires a clean build.
944
94520201223:
946	The FreeBSD project has migrated from Subversion to Git. Temporary
947	instructions can be found at
948	https://github.com/bsdimp/freebsd-git-docs/blob/main/src-cvt.md
949	and other documents in that repo.
950
95120201216:
952	The services database has been updated to cover more of the basic
953	services expected in a modern system. The database is big enough
954	that it will cause issues in mergemaster in Releases previous to
955	12.2 and 11.3, or in very old current systems from before r358154.
956
95720201215:
958	Obsolete in-tree GDB 6.1.1 has been removed.  GDB (including kgdb)
959	may be installed from ports or packages.
960
96120201124:
962	ping6 has been merged into ping.  It can now be called as "ping -6".
963	See ping(8) for details.
964
96520201108:
966	Default value of net.add_addr_allfibs has been changed to 0.
967	If you have multi-fib configuration and rely on existence of all
968	interface routes in every fib, you need to set the above sysctl to 1.
969
97020201030:
971	The internal pre-processor in the calendar(1) program has been
972	extended to support more C pre-processor commands (e.g. #ifdef, #else,
973	and #undef) and to detect unbalanced conditional statements.
974	Error messages have been extended to include the filename and line
975	number if processing stops to help fixing malformed data files.
976
97720201026:
978	All the data files for the calendar(1) program, except calendar.freebsd,
979	have been moved to the deskutils/calendar-data port, much like the
980	jewish calendar entries were moved to deskutils/hebcal years ago. After
981	make delete-old-files, you need to install it to retain full
982	functionality. calendar(1) will issue a reminder for files it can't
983	find.
984
98520200923:
986	LINT files are no longer generated. We now include the relevant NOTES
987	files. Note: This may cause conflicts with updating in some cases.
988	        find sys -name LINT\* -delete
989	is suggested across this commit	to remove the generated	LINT files.
990
991	If you have tried to update with generated files there, the svn
992	command you want to un-auger the tree is
993		cd sys/amd64/conf
994		svn revert -R .
995	and then do the above find from the top level. Substitute 'amd64'
996	above with where the error message indicates a conflict.
997
99820200824:
999	OpenZFS support has been integrated. Do not upgrade root pools until
1000	the loader is updated to support zstd. Furthermore, we caution against
1001	'zpool upgrade' for the next few weeks. The change should be transparent
1002	unless you  want to use new features.
1003
1004	Not all "NO_CLEAN" build scenarios work across these changes. Many
1005	scenarios have been tested and fixed, but rebuilding kernels without
1006	rebuilding world may fail.
1007
1008	The ZFS cache file has moved from /boot to /etc to match the OpenZFS
1009	upstream default. A fallback to /boot has been added for mountroot.
1010
1011	Pool auto import behavior at boot has been moved from the kernel module
1012	to an explicit "zpool import -a" in one of the rc scripts enabled by
1013	zfs_enable=YES. This means your non-root zpools won't auto import until
1014	you upgrade your /etc/rc.d files.
1015
101620200824:
1017	The resume code now notifies devd with the 'kernel' system
1018	rather than the old 'kern' subsystem to be consistent with
1019	other use. The old notification will be created as well, but
1020	will be removed prior to FreeBSD 14.0.
1021
102220200821:
1023	r362275 changed the internal API between the kernel RPC and the
1024	NFS modules. As such, all the modules must be recompiled from
1025	sources.
1026
102720200817:
1028	r364330 modified the internal API used between the NFS modules.
1029	As such, all the NFS modules must be re-compiled from sources.
1030
103120200816:
1032	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
1033	been upgraded to 11.0.0.  Please see the 20141231 entry below for
1034	information about prerequisites and upgrading, if you are not already
1035	using clang 3.5.0 or higher.
1036
103720200810:
1038	r364092 modified the internal ABI used between the kernel NFS
1039	modules.  As such, all of these modules need to be rebuilt
1040	from sources, so a version bump was done.
1041
104220200807:
1043	Makefile.inc has been updated to work around the issue documented in
1044	20200729. It was a case where the optimization of using symbolic links
1045	to point to binaries created a situation where we'd run new binaries
1046	with old libraries starting midway through the installworld process.
1047
104820200729:
1049	r363679 has redefined some undefined behavior in regcomp(3); notably,
1050	extraneous escapes of most ordinary characters will no longer be
1051	accepted.  An exp-run has identified all of the problems with this in
1052	ports, but other non-ports software may need extra escapes removed to
1053	continue to function.
1054
1055	Because of this change, installworld may encounter the following error
1056	from rtld: Undefined symbol "regcomp@FBSD_1.6" -- It is imperative that
1057	you do not halt installworld. Instead, let it run to completion (whether
1058	successful or not) and run installworld once more.
1059
106020200627:
1061	A new implementation of bc and dc has been imported in r362681. This
1062	implementation corrects non-conformant behavior of the previous bc
1063	and adds GNU bc compatible options. It offers a number of extensions,
1064	is much faster on large values, and has support for message catalogs
1065	(a number of languages are already supported, contributions of further
1066	languages welcome). The option WITHOUT_GH_BC can be used to build the
1067	world with the previous versions of bc and dc.
1068
106920200625:
1070	r362639 changed the internal API used between the NFS kernel modules.
1071	As such, they all need to be rebuilt from sources.
1072
107320200613:
1074	r362158 changed the arguments for VFS_CHECKEXP().  As such, any
1075	out of tree file systems need to be modified and rebuilt.
1076	Also, any file systems that are modules must be rebuilt.
1077
107820200604:
1079	read(2) of a directory fd is now rejected by default.  root may
1080	re-enable it for system root only on non-ZFS filesystems with the
1081	security.bsd.allow_read_dir sysctl(8) MIB if
1082	security.bsd.suser_enabled=1.
1083
1084	It may be advised to setup aliases for grep to default to `-d skip` if
1085	commonly non-recursively grepping a list that includes directories and
1086	the potential for the resulting stderr output is not tolerable.  Example
1087	aliases are now installed, commented out, in /root/.cshrc and
1088	/root/.shrc.
1089
109020200523:
1091	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
1092	been upgraded to 10.0.1.  Please see the 20141231 entry below for
1093	information about prerequisites and upgrading, if you are not already
1094	using clang 3.5.0 or higher.
1095
109620200512:
1097	Support for obsolete compilers has been removed from the build system.
1098	Clang 6 and GCC 6.4 are the minimum supported versions.
1099
110020200424:
1101	closefrom(2) has been moved under COMPAT12, and replaced in libc with a
1102	stub that calls close_range(2).  If using a custom kernel configuration,
1103	you may want to ensure that the COMPAT_FREEBSD12 option is included, as
1104	a slightly older -CURRENT userland and older FreeBSD userlands may not
1105	be functional without closefrom(2).
1106
110720200414:
1108	Upstream DTS from Linux 5.6 was merged and they now have the SID
1109	and THS (Secure ID controller and THermal Sensor) node present.
1110	The DTB overlays have now been removed from the tree for the H3/H5 and
1111	A64 SoCs and the aw_sid and aw_thermal driver have been updated to
1112	deal with upstream DTS. If you are using those overlays you need to
1113	remove them from loader.conf and update the DTBs on the FAT partition.
1114
111520200310:
1116	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
1117	been upgraded to 10.0.0.  Please see the 20141231 entry below for
1118	information about prerequisites and upgrading, if you are not already
1119	using clang 3.5.0 or higher.
1120
112120200309:
1122	The amd(8) automount daemon has been removed from the source tree.
1123	As of FreeBSD 10.1 autofs(5) is the preferred tool for automounting.
1124	amd is still available in the sysutils/am-utils port.
1125
112620200301:
1127	Removed brooktree driver (bktr.4) from the tree.
1128
112920200229:
1130	The WITH_GPL_DTC option has been removed.  The BSD-licenced device tree
1131	compiler in usr.bin/dtc is used on all architectures which use dtc, and
1132	the GPL dtc is available (if needed) from the sysutils/dtc port.
1133
113420200229:
1135	The WITHOUT_LLVM_LIBUNWIND option has been removed.  LLVM's libunwind
1136	is used by all supported CPU architectures.
1137
113820200229:
1139	GCC 4.2.1 has been removed from the tree.  The WITH_GCC,
1140	WITH_GCC_BOOTSTRAP, and WITH_GNUCXX options are no longer available.
1141	Users who wish to build FreeBSD with GCC must use the external toolchain
1142	ports or packages.
1143
114420200220:
1145	ncurses has been updated to a newer version (6.2-20200215). Given the ABI
1146	has changed, users will have to rebuild all the ports that are linked to
1147	ncurses.
1148
114920200217:
1150	The size of struct vnet and the magic cookie have changed.
1151	Users need to recompile libkvm and all modules using VIMAGE
1152	together with their new kernel.
1153
115420200212:
1155	Defining the long deprecated NO_CTF, NO_DEBUG_FILES, NO_INSTALLLIB,
1156	NO_MAN, NO_PROFILE, and NO_WARNS variables is now an error.  Update
1157	your Makefiles and scripts to define MK_<var>=no instead as required.
1158
1159	One exception to this is that program or library Makefiles should
1160	define MAN to empty rather than setting MK_MAN=no.
1161
116220200108:
1163	Clang/LLVM is now the default compiler and LLD the default
1164	linker for riscv64.
1165
116620200107:
1167	make universe no longer uses GCC 4.2.1 on any architectures.
1168	Architectures not supported by in-tree Clang/LLVM require an
1169	external toolchain package.
1170
117120200104:
1172	GCC 4.2.1 is now not built by default, as part of the GCC 4.2.1
1173	retirement plan.  Specifically, the GCC, GCC_BOOTSTRAP, and GNUCXX
1174	options default to off for all supported CPU architectures.  As a
1175	short-term transition aid they may be enabled via WITH_* options.
1176	GCC 4.2.1 is expected to be removed from the tree on 2020-03-31.
1177
117820200102:
1179	Support for armv5 has been disconnected and is being removed. The
1180	machine combination MACHINE=arm MACHINE_ARCH=arm is no longer valid.
1181	You must now use a MACHINE_ARCH of armv6 or armv7. The default
1182	MACHINE_ARCH for MACHINE=arm is now armv7.
1183
118420191226:
1185	Clang/LLVM is now the default compiler for all powerpc architectures.
1186	LLD is now the default linker for powerpc64.  The change for powerpc64
1187	also includes a change to the ELFv2 ABI, incompatible with the existing
1188	ABI.
1189
119020191226:
1191	Kernel-loadable random(4) modules are no longer unloadable.
1192
119320191222:
1194	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
1195	been upgraded to 9.0.1.  Please see the 20141231 entry below for
1196	information about prerequisites and upgrading, if you are not already
1197	using clang 3.5.0 or higher.
1198
119920191212:
1200	r355677 has modified the internal interface used between the
1201	NFS modules in the kernel. As such, they must all be upgraded
1202	simultaneously. I will do a version bump for this.
1203
120420191205:
1205	The root certificates of the Mozilla CA Certificate Store have been
1206	imported into the base system and can be managed with the certctl(8)
1207	utility.  If you have installed the security/ca_root_nss port or package
1208	with the ETCSYMLINK option (the default), be advised that there may be
1209	differences between those included in the port and those included in
1210	base due to differences in nss branch used as well as general update
1211	frequency.  Note also that certctl(8) cannot manage certs in the
1212	format used by the security/ca_root_nss port.
1213
121420191120:
1215	The amd(8) automount daemon has been disabled by default, and will be
1216	removed in the future.  As of FreeBSD 10.1 the autofs(5) is available
1217	for automounting.
1218
121920191107:
1220	The nctgpio and wbwd drivers have been moved to the superio bus.
1221	If you have one of these drivers in a kernel configuration, then
1222	you should add device superio to it.  If you use one of these drivers
1223	as a module and you compile a custom set of modules, then you should
1224	add superio to the set.
1225
122620191021:
1227	KPIs for network drivers to access interface addresses have changed.
1228	Users need to recompile NIC driver modules together with kernel.
1229
123020191021:
1231	The net.link.tap.user_open sysctl no longer prevents user opening of
1232	already created /dev/tapNN devices.  Access is still controlled by
1233	node permissions, just like tun devices.  The net.link.tap.user_open
1234	sysctl is now used only to allow users to perform devfs cloning of
1235	tap devices, and the subsequent open may not succeed if the user is not
1236	in the appropriate group.  This sysctl may be deprecated/removed
1237	completely in the future.
1238
123920191009:
1240	mips, powerpc, and sparc64 are no longer built as part of
1241	universe / tinderbox unless MAKE_OBSOLETE_GCC is defined. If
1242	not defined, mips, powerpc, and sparc64 builds will look for
1243	the xtoolchain binaries and if installed use them for universe
1244	builds. As llvm 9.0 becomes vetted for these architectures, they
1245	will be removed from the list.
1246
124720191009:
1248	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
1249	been upgraded to 9.0.0.  Please see the 20141231 entry below for
1250	information about prerequisites and upgrading, if you are not already
1251	using clang 3.5.0 or higher.
1252
125320191003:
1254	The hpt27xx, hptmv, hptnr, and hptrr drivers have been removed from
1255	GENERIC.  They are available as modules and can be loaded by adding
1256	to /boot/loader.conf hpt27xx_load="YES", hptmv_load="YES",
1257	hptnr_load="YES", or hptrr_load="YES", respectively.
1258
125920190913:
1260	ntpd no longer by default locks its pages in memory, allowing them
1261	to be paged out by the kernel. Use rlimit memlock to restore
1262	historic BSD behaviour. For example, add "rlimit memlock 32"
1263	to ntp.conf to lock up to 32 MB of ntpd address space in memory.
1264
126520190823:
1266	Several of ping6's options have been renamed for better consistency
1267	with ping.  If you use any of -ARWXaghmrtwx, you must update your
1268	scripts.  See ping6(8) for details.
1269
127020190727:
1271	The vfs.fusefs.sync_unmount and vfs.fusefs.init_backgrounded sysctls
1272	and the "-o sync_unmount" and "-o init_backgrounded" mount options have
1273	been removed from mount_fusefs(8).  You can safely remove them from
1274	your scripts, because they had no effect.
1275
1276	The vfs.fusefs.fix_broken_io, vfs.fusefs.sync_resize,
1277	vfs.fusefs.refresh_size, vfs.fusefs.mmap_enable,
1278	vfs.fusefs.reclaim_revoked, and vfs.fusefs.data_cache_invalidate
1279	sysctls have been removed.  If you felt the need to set any of them to
1280	a non-default value, please tell asomers@FreeBSD.org why.
1281
128220190713:
1283	Default permissions on the /var/account/acct file (and copies of it
1284	rotated by periodic daily scripts) are changed from 0644 to 0640
1285	because the file contains sensitive information that should not be
1286	world-readable.  If the /var/account directory must be created by
1287	rc.d/accounting, the mode used is now 0750.  Admins who use the
1288	accounting feature are encouraged to change the mode of an existing
1289	/var/account directory to 0750 or 0700.
1290
129120190620:
1292	Entropy collection and the /dev/random device are no longer optional
1293	components.  The "device random" option has been removed.
1294	Implementations of distilling algorithms can still be made loadable
1295	with "options RANDOM_LOADABLE" (e.g., random_fortuna.ko).
1296
129720190612:
1298	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
1299	been upgraded to 8.0.1.  Please see the 20141231 entry below for
1300	information about prerequisites and upgrading, if you are not already
1301	using clang 3.5.0 or higher.
1302
130320190608:
1304	A fix was applied to i386 kernel modules to avoid panics with
1305	dpcpu or vnet.  Users need to recompile i386 kernel modules
1306	having pcpu or vnet sections or they will refuse to load.
1307
130820190513:
1309	User-wired pages now have their own counter,
1310	vm.stats.vm.v_user_wire_count.  The vm.max_wired sysctl was renamed
1311	to vm.max_user_wired and changed from an unsigned int to an unsigned
1312	long.  bhyve VMs wired with the -S are now subject to the user
1313	wiring limit; the vm.max_user_wired sysctl may need to be tuned to
1314	avoid running into the limit.
1315
131620190507:
1317	The IPSEC option has been removed from GENERIC.  Users requiring
1318	ipsec(4) must now load the ipsec(4) kernel module.
1319
132020190507:
1321	The tap(4) driver has been folded into tun(4), and the module has been
1322	renamed to tuntap.  You should update any kld_list="if_tap" or
1323	kld_list="if_tun" entries in /etc/rc.conf, if_tap_load="YES" or
1324	if_tun_load="YES" entries in /boot/loader.conf to load the if_tuntap
1325	module instead, and "device tap" or "device tun" entries in kernel
1326	config files to select the tuntap device instead.
1327
132820190418:
1329	The following knobs have been added related to tradeoffs between
1330	safe use of the random device and availability in the absence of
1331	entropy:
1332
1333	kern.random.initial_seeding.bypass_before_seeding: tunable; set
1334	non-zero to bypass the random device prior to seeding, or zero to
1335	block random requests until the random device is initially seeded.
1336	For now, set to 1 (unsafe) by default to restore pre-r346250 boot
1337	availability properties.
1338
1339	kern.random.initial_seeding.read_random_bypassed_before_seeding:
1340	read-only diagnostic sysctl that is set when bypass is enabled and
1341	read_random(9) is bypassed, to enable programmatic handling of this
1342	initial condition, if desired.
1343
1344	kern.random.initial_seeding.arc4random_bypassed_before_seeding:
1345	Similar to the above, but for arc4random(9) initial seeding.
1346
1347	kern.random.initial_seeding.disable_bypass_warnings: tunable; set
1348	non-zero to disable warnings in dmesg when the same conditions are
1349	met as for the diagnostic sysctls above.  Defaults to zero, i.e.,
1350	produce warnings in dmesg when the conditions are met.
1351
135220190416:
1353	The loadable random module KPI has changed; the random_infra_init()
1354	routine now requires a 3rd function pointer for a bool (*)(void)
1355	method that returns true if the random device is seeded (and
1356	therefore unblocked).
1357
135820190404:
1359	r345895 reverts r320698. This implies that an nfsuserd(8) daemon
1360	built from head sources between r320757 (July 6, 2017) and
1361	r338192 (Aug. 22, 2018) will not work unless the "-use-udpsock"
1362	is added to the command line.
1363	nfsuserd daemons built from head sources that are post-r338192 are
1364	not affected and should continue to work.
1365
136620190320:
1367	The fuse(4) module has been renamed to fusefs(4) for consistency with
1368	other filesystems.  You should update any kld_load="fuse" entries in
1369	/etc/rc.conf, fuse_load="YES" entries in /boot/loader.conf, and
1370	"options FUSE" entries in kernel config files.
1371
137220190304:
1373	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
1374	8.0.0.  Please see the 20141231 entry below for information about
1375	prerequisites and upgrading, if you are not already using clang 3.5.0
1376	or higher.
1377
137820190226:
1379	geom_uzip(4) depends on the new module xz.  If geom_uzip is statically
1380	compiled into your custom kernel, add 'device xz' statement to the
1381	kernel config.
1382
138320190219:
1384	drm and drm2 have been removed from the tree. Please see
1385	https://wiki.freebsd.org/Graphics for the latest information on
1386	migrating to the drm ports.
1387
138820190131:
1389	Iflib is no longer unconditionally compiled into the kernel.  Drivers
1390	using iflib and statically compiled into the kernel, now require
1391	the 'device iflib' config option.  For the same drivers loaded as
1392	modules on kernels not having 'device iflib', the iflib.ko module
1393	is loaded automatically.
1394
139520190125:
1396	The IEEE80211_AMPDU_AGE and AH_SUPPORT_AR5416 kernel configuration
1397	options no longer exist since r343219 and r343427 respectively;
1398	nothing uses them, so they should be just removed from custom
1399	kernel config files.
1400
140120181230:
1402	r342635 changes the way efibootmgr(8) works by requiring users to add
1403	the -b (bootnum) parameter for commands where the bootnum was previously
1404	specified with each option. For example 'efibootmgr -B 0001' is now
1405	'efibootmgr -B -b 0001'.
1406
140720181220:
1408	r342286 modifies the NFSv4 server so that it obeys vfs.nfsd.nfs_privport
1409	in the same as it is applied to NFSv2 and 3.  This implies that NFSv4
1410	servers that have vfs.nfsd.nfs_privport set will only allow mounts
1411	from clients using a reserved port. Since both the FreeBSD and Linux
1412	NFSv4 clients use reserved ports by default, this should not affect
1413	most NFSv4 mounts.
1414
141520181219:
1416	The XLP config has been removed. We can't support 64-bit atomics in this
1417	kernel because it is running in 32-bit mode. XLP users must transition
1418	to running a 64-bit kernel (XLP64 or XLPN32).
1419
1420	The mips GXEMUL support has been removed from FreeBSD. MALTA* + qemu is
1421	the preferred emulator today and we don't need two different ones.
1422
1423	The old sibyte / swarm / Broadcom BCM1250 support has been
1424	removed from the mips port.
1425
142620181211:
1427	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
1428	7.0.1.  Please see the 20141231 entry below for information about
1429	prerequisites and upgrading, if you are not already using clang 3.5.0
1430	or higher.
1431
143220181211:
1433	Remove the timed and netdate programs from the base tree.  Setting
1434	the time with these daemons has been obsolete for over a decade.
1435
143620181126:
1437	On amd64, arm64 and armv7 (architectures that install LLVM's ld.lld
1438	linker as /usr/bin/ld) GNU ld is no longer installed as ld.bfd, as
1439	it produces broken binaries when ifuncs are in use.  Users needing
1440	GNU ld should install the binutils port or package.
1441
144220181123:
1443	The BSD crtbegin and crtend code has been enabled by default. It has
1444	had extensive testing on amd64, arm64, and i386. It can be disabled
1445	by building a world with -DWITHOUT_BSD_CRTBEGIN.
1446
144720181115:
1448	The set of CTM commands (ctm, ctm_smail, ctm_rmail, ctm_dequeue)
1449	has been converted to a port (misc/ctm) and will be removed from
1450	FreeBSD-13.  It is available as a package (ctm) for all supported
1451	FreeBSD versions.
1452
145320181110:
1454	The default newsyslog.conf(5) file has been changed to only include
1455	files in /etc/newsyslog.conf.d/ and /usr/local/etc/newsyslog.conf.d/ if
1456	the filenames end in '.conf' and do not begin with a '.'.
1457
1458	You should check the configuration files in these two directories match
1459	this naming convention. You can verify which configuration files are
1460	being included using the command:
1461		$ newsyslog -Nrv
1462
146320181019:
1464	Stable/12 was branched created.
1465
146620181015:
1467	Ports for the DRM modules have been simplified. Now, amd64 users should
1468	just install the drm-kmod port. All others should install
1469	drm-legacy-kmod.
1470
1471	Graphics hardware that's newer than about 2010 usually works with
1472	drm-kmod.  For hardware older than 2013, however, some users will need
1473	to use drm-legacy-kmod if drm-kmod doesn't work for them. Hardware older
1474	than 2008 usually only works in drm-legacy-kmod. The graphics team can
1475	only commit to hardware made since 2013 due to the complexity of the
1476	market and difficulty to test all the older cards effectively. If you
1477	have hardware supported by drm-kmod, you are strongly encouraged to use
1478	that as you will get better support.
1479
1480	Other than KPI chasing, drm-legacy-kmod will not be updated. As outlined
1481	elsewhere, the drm and drm2 modules will be eliminated from the src base
1482	soon (with a limited exception for arm). Please update to the package
1483	asap and report any issues to x11@freebsd.org.
1484
1485	Generally, anybody using the drm*-kmod packages should add
1486	WITHOUT_DRM_MODULE=t and WITHOUT_DRM2_MODULE=t to avoid nasty
1487	cross-threading surprises, especially with automatic driver
1488	loading from X11 startup. These will become the defaults in 13-current
1489	shortly.
1490
149120181012:
1492	The ixlv(4) driver has been renamed to iavf(4).  As a consequence,
1493	custom kernel and module loading configuration files must be updated
1494	accordingly.  Moreover, interfaces previous presented as ixlvN to the
1495	system are now exposed as iavfN and network configuration files must
1496	be adjusted as necessary.
1497
149820181009:
1499	OpenSSL has been updated to version 1.1.1.  This update included
1500	additional various API changes throughout the base system.  It is
1501	important to rebuild third-party software after upgrading.  The value
1502	of __FreeBSD_version has been bumped accordingly.
1503
150420181006:
1505	The legacy DRM modules and drivers have now been added to the loader's
1506	module blacklist, in favor of loading them with kld_list in rc.conf(5).
1507	The module blacklist may be overridden with the loader.conf(5)
1508	'module_blacklist' variable, but loading them via rc.conf(5) is strongly
1509	encouraged.
1510
151120181002:
1512	The cam(4) based nda(4) driver will be used over nvd(4) by default on
1513	powerpc64. You may set 'options NVME_USE_NVD=1' in your kernel conf or
1514	loader tunable 'hw.nvme.use_nvd=1' if you wish to use the existing
1515	driver.  Make sure to edit /boot/etc/kboot.conf and fstab to use the
1516	nda device name.
1517
151820180913:
1519	Reproducible build mode is now on by default, in preparation for
1520	FreeBSD 12.0.  This eliminates build metadata such as the user,
1521	host, and time from the kernel (and uname), unless the working tree
1522	corresponds to a modified checkout from a version control system.
1523	The previous behavior can be obtained by setting the /etc/src.conf
1524	knob WITHOUT_REPRODUCIBLE_BUILD.
1525
152620180826:
1527	The Yarrow CSPRNG has been removed from the kernel as it has not been
1528	supported by its designers since at least 2003. Fortuna has been the
1529	default since FreeBSD-11.
1530
153120180822:
1532	devctl freeze/thaw have gone into the tree, the rc scripts have been
1533	updated to use them and devmatch has been changed.  You should update
1534	kernel, userland and rc scripts all at the same time.
1535
153620180818:
1537	The default interpreter has been switched from 4th to Lua.
1538	LOADER_DEFAULT_INTERP, documented in build(7), will override the default
1539	interpreter.  If you have custom FORTH code you will need to set
1540	LOADER_DEFAULT_INTERP=4th (valid values are 4th, lua or simp) in
1541	src.conf for the build.  This will create default hard links between
1542	loader and loader_4th instead of loader and loader_lua, the new default.
1543	If you are using UEFI it will create the proper hard link to loader.efi.
1544
1545	bhyve uses userboot.so. It remains 4th-only until some issues are solved
1546	regarding coexisting with multiple versions of FreeBSD are resolved.
1547
154820180815:
1549	ls(1) now respects the COLORTERM environment variable used in other
1550	systems and software to indicate that a colored terminal is both
1551	supported and desired.  If ls(1) is suddenly emitting colors, they may
1552	be disabled again by either removing the unwanted COLORTERM from your
1553	environment, or using `ls --color=never`.  The ls(1) specific CLICOLOR
1554	may not be observed in a future release.
1555
155620180808:
1557	The default pager for most commands has been changed to "less".  To
1558	restore the old behavior, set PAGER="more" and MANPAGER="more -s" in
1559	your environment.
1560
156120180731:
1562	The jedec_ts(4) driver has been removed. A superset of its functionality
1563	is available in the jedec_dimm(4) driver, and the manpage for that
1564	driver includes migration instructions. If you have "device jedec_ts"
1565	in your kernel configuration file, it must be removed.
1566
156720180730:
1568	amd64/GENERIC now has EFI runtime services, EFIRT, enabled by default.
1569	This should have no effect if the kernel is booted via BIOS/legacy boot.
1570	EFIRT may be disabled via a loader tunable, efi.rt.disabled, if a system
1571	has a buggy firmware that prevents a successful boot due to use of
1572	runtime services.
1573
157420180727:
1575	Atmel AT91RM9200 and AT91SAM9, Cavium CNS 11xx and XScale
1576	support has been removed from the tree. These ports were
1577	obsolete and/or known to be broken for many years.
1578
157920180723:
1580	loader.efi has been augmented to participate more fully in the
1581	UEFI boot manager protocol. loader.efi will now look at the
1582	BootXXXX environment variable to determine if a specific kernel
1583	or root partition was specified. XXXX is derived from BootCurrent.
1584	efibootmgr(8) manages these standard UEFI variables.
1585
158620180720:
1587	zfsloader's functionality has now been folded into loader.
1588	zfsloader is no longer necessary once you've updated your
1589	boot blocks. For a transition period, we will install a
1590	hardlink for zfsloader to loader to allow a smooth transition
1591	until the boot blocks can be updated (hard link because old
1592	zfs boot blocks don't understand symlinks).
1593
159420180719:
1595	ARM64 now have efifb support, if you want to have serial console
1596	on your arm64 board when an screen is connected and the bootloader
1597	setup a frame buffer for us to use, just add :
1598	boot_serial=YES
1599	boot_multicons=YES
1600	in /boot/loader.conf
1601	For Raspberry Pi 3 (RPI) users, this is needed even if you don't have
1602	an screen connected as the firmware will setup a frame buffer are that
1603	u-boot will expose as an EFI frame buffer.
1604
160520180719:
1606	New uid:gid added, ntpd:ntpd (123:123).  Be sure to run mergemaster
1607	or take steps to update /etc/passwd before doing installworld on
1608	existing systems.  Do not skip the "mergemaster -Fp" step before
1609	installworld, as described in the update procedures near the bottom
1610	of this document.  Also, rc.d/ntpd now starts ntpd(8) as user ntpd
1611	if the new mac_ntpd(4) policy is available, unless ntpd_flags or
1612	the ntp config file contain options that change file/dir locations.
1613	When such options (e.g., "statsdir" or "crypto") are used, ntpd can
1614	still be run as non-root by setting ntpd_user=ntpd in rc.conf, after
1615	taking steps to ensure that all required files/dirs are accessible
1616	by the ntpd user.
1617
161820180717:
1619	Big endian arm support has been removed.
1620
162120180711:
1622	The static environment setup in kernel configs is no longer mutually
1623	exclusive with the loader(8) environment by default.  In order to
1624	restore the previous default behavior of disabling the loader(8)
1625	environment if a static environment is present, you must specify
1626	loader_env.disabled=1 in the static environment.
1627
162820180705:
1629	The ABI of syscalls used by management tools like sockstat and
1630	netstat has been broken to allow 32-bit binaries to work on
1631	64-bit kernels without modification.  These programs will need
1632	to match the kernel in order to function.  External programs may
1633	require minor modifications to accommodate a change of type in
1634	structures from pointers to 64-bit virtual addresses.
1635
163620180702:
1637	On i386 and amd64 atomics are now inlined. Out of tree modules using
1638	atomics will need to be rebuilt.
1639
164020180701:
1641	The '%I' format in the kern.corefile sysctl limits the number of
1642	core files that a process can generate to the number stored in the
1643	debug.ncores sysctl. The '%I' format is replaced by the single digit
1644	index. Previously, if all indexes were taken the kernel would overwrite
1645	only a core file with the highest index in a filename.
1646	Currently the system will create a new core file if there is a free
1647	index or if all slots are taken it will overwrite the oldest one.
1648
164920180630:
1650	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
1651	6.0.1.  Please see the 20141231 entry below for information about
1652	prerequisites and upgrading, if you are not already using clang 3.5.0
1653	or higher.
1654
165520180628:
1656	r335753 introduced a new quoting method. However, etc/devd/devmatch.conf
1657	needed to be changed to work with it. This change was made with r335763
1658	and requires a mergemaster / etcupdate / etc to update the installed
1659	file.
1660
166120180612:
1662	r334930 changed the interface between the NFS modules, so they all
1663	need to be rebuilt.  r335018 did a __FreeBSD_version bump for this.
1664
166520180530:
1666	As of r334391 lld is the default amd64 system linker; it is installed
1667	as /usr/bin/ld.  Kernel build workarounds (see 20180510 entry) are no
1668	longer necessary.
1669
167020180530:
1671	The kernel / userland interface for devinfo changed, so you'll
1672	need a new kernel and userland as a pair for it to work (rebuilding
1673	lib/libdevinfo is all that's required). devinfo and devmatch will
1674	not work, but everything else will when there's a mismatch.
1675
167620180523:
1677	The on-disk format for hwpmc callchain records has changed to include
1678	threadid corresponding to a given record. This changes the field offsets
1679	and thus requires that libpmcstat be rebuilt before using a kernel
1680	later than r334108.
1681
168220180517:
1683	The vxge(4) driver has been removed.  This driver was introduced into
1684	HEAD one week before the Exar left the Ethernet market and is not
1685	known to be used.  If you have device vxge in your kernel config file
1686	it must be removed.
1687
168820180510:
1689	The amd64 kernel now requires a ld that supports ifunc to produce a
1690	working kernel, either lld or a newer binutils. lld is built by default
1691	on amd64, and the 'buildkernel' target uses it automatically. However,
1692	it is not the default linker, so building the kernel the traditional
1693	way requires LD=ld.lld on the command line (or LD=/usr/local/bin/ld for
1694	binutils port/package). lld will soon be default, and this requirement
1695	will go away.
1696
1697	NOTE: As of r334391 lld is the default system linker on amd64, and no
1698	workaround is necessary.
1699
170020180508:
1701	The nxge(4) driver has been removed.  This driver was for PCI-X 10g
1702	cards made by s2io/Neterion.  The company was acquired by Exar and
1703	no longer sells or supports Ethernet products.  If you have device
1704	nxge in your kernel config file it must be removed.
1705
170620180504:
1707	The tz database (tzdb) has been updated to 2018e.  This version more
1708	correctly models time stamps in time zones with negative DST such as
1709	Europe/Dublin (from 1971 on), Europe/Prague (1946/7), and
1710	Africa/Windhoek (1994/2017).  This does not affect the UT offsets, only
1711	time zone abbreviations and the tm_isdst flag.
1712
171320180502:
1714	The ixgb(4) driver has been removed.  This driver was for an early and
1715	uncommon legacy PCI 10GbE for a single ASIC, Intel 82597EX. Intel
1716	quickly shifted to the long lived ixgbe family.  If you have device
1717	ixgb in your kernel config file it must be removed.
1718
171920180501:
1720	The lmc(4) driver has been removed.  This was a WAN interface
1721	card that was already reportedly rare in 2003, and had an ambiguous
1722	license.  If you have device lmc in your kernel config file it must
1723	be removed.
1724
172520180413:
1726	Support for Arcnet networks has been removed.  If you have device
1727	arcnet or device cm in your kernel config file they must be
1728	removed.
1729
173020180411:
1731	Support for FDDI networks has been removed.  If you have device
1732	fddi or device fpa in your kernel config file they must be
1733	removed.
1734
173520180406:
1736	In addition to supporting RFC 3164 formatted messages, the
1737	syslogd(8) service is now capable of parsing RFC 5424 formatted
1738	log messages. The main benefit of using RFC 5424 is that clients
1739	may now send log messages with timestamps containing year numbers,
1740	microseconds and time zone offsets.
1741
1742	Similarly, the syslog(3) C library function has been altered to
1743	send RFC 5424 formatted messages to the local system logging
1744	daemon. On systems using syslogd(8), this change should have no
1745	negative impact, as long as syslogd(8) and the C library are
1746	updated at the same time. On systems using a different system
1747	logging daemon, it may be necessary to make configuration
1748	adjustments, depending on the software used.
1749
1750	When using syslog-ng, add the 'syslog-protocol' flag to local
1751	input sources to enable parsing of RFC 5424 formatted messages:
1752
1753		source src {
1754			unix-dgram("/var/run/log" flags(syslog-protocol));
1755		}
1756
1757	When using rsyslog, disable the 'SysSock.UseSpecialParser' option
1758	of the 'imuxsock' module to let messages be processed by the
1759	regular RFC 3164/5424 parsing pipeline:
1760
1761		module(load="imuxsock" SysSock.UseSpecialParser="off")
1762
1763	Do note that these changes only affect communication between local
1764	applications and syslogd(8). The format that syslogd(8) uses to
1765	store messages on disk or forward messages to other systems
1766	remains unchanged. syslogd(8) still uses RFC 3164 for these
1767	purposes. Options to customize this behaviour will be added in the
1768	future. Utilities that process log files stored in /var/log are
1769	thus expected to continue to function as before.
1770
1771	__FreeBSD_version has been incremented to 1200061 to denote this
1772	change.
1773
177420180328:
1775	Support for token ring networks has been removed. If you
1776	have "device token" in your kernel config you should remove
1777	it. No device drivers supported token ring.
1778
177920180323:
1780	makefs was modified to be able to tag ISO9660 El Torito boot catalog
1781	entries as EFI instead of overloading the i386 tag as done previously.
1782	The amd64 mkisoimages.sh script used to build amd64 ISO images for
1783	release was updated to use this. This may mean that makefs must be
1784	updated before "make cdrom" can be run in the release directory. This
1785	should be as simple as:
1786
1787		$ cd $SRCDIR/usr.sbin/makefs
1788		$ make depend all install
1789
179020180212:
1791	FreeBSD boot loader enhanced with Lua scripting. It's purely opt-in for
1792	now by building WITH_LOADER_LUA and WITHOUT_FORTH in /etc/src.conf.
1793	Co-existence for the transition period will come shortly. Booting is a
1794	complex environment and test coverage for Lua-enabled loaders has been
1795	thin, so it would be prudent to assume it might not work and make
1796	provisions for backup boot methods.
1797
179820180211:
1799	devmatch functionality has been turned on in devd. It will automatically
1800	load drivers for unattached devices. This may cause unexpected drivers
1801	to be loaded. Please report any problems to current@ and
1802	imp@freebsd.org.
1803
180420180114:
1805	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
1806	6.0.0.  Please see the 20141231 entry below for information about
1807	prerequisites and upgrading, if you are not already using clang 3.5.0
1808	or higher.
1809
181020180110:
1811	LLVM's lld linker is now used as the FreeBSD/amd64 bootstrap linker.
1812	This means it is used to link the kernel and userland libraries and
1813	executables, but is not yet installed as /usr/bin/ld by default.
1814
1815	To revert to ld.bfd as the bootstrap linker, in /etc/src.conf set
1816	WITHOUT_LLD_BOOTSTRAP=yes
1817
181820180110:
1819	On i386, pmtimer has been removed. Its functionality has been folded
1820	into apm. It was a no-op on ACPI in current for a while now (but was
1821	still needed on i386 in FreeBSD 11 and earlier). Users may need to
1822	remove it from kernel config files.
1823
182420180104:
1825	The use of RSS hash from the network card aka flowid has been
1826	disabled by default for lagg(4) as it's currently incompatible with
1827	the lacp and loadbalance protocols.
1828
1829	This can be re-enabled by setting the following in loader.conf:
1830	net.link.lagg.default_use_flowid="1"
1831
183220180102:
1833	The SW_WATCHDOG option is no longer necessary to enable the
1834	hardclock-based software watchdog if no hardware watchdog is
1835	configured. As before, SW_WATCHDOG will cause the software
1836	watchdog to be enabled even if a hardware watchdog is configured.
1837
183820171215:
1839	r326887 fixes the issue described in the 20171214 UPDATING entry.
1840	r326888 flips the switch back to building GELI support always.
1841
184220171214:
1843	r362593 broke ZFS + GELI support for reasons unknown. However,
1844	it also broke ZFS support generally, so GELI has been turned off
1845	by default as the lesser evil in r326857. If you boot off ZFS and/or
1846	GELI, it might not be a good time to update.
1847
184820171125:
1849	PowerPC users must update loader(8) by rebuilding world before
1850	installing a new kernel, as the protocol connecting them has
1851	changed. Without the update, loader metadata will not be passed
1852	successfully to the kernel and users will have to enter their
1853	root partition at the kernel mountroot prompt to continue booting.
1854	Newer versions of loader can boot old kernels without issue.
1855
185620171110:
1857	The LOADER_FIREWIRE_SUPPORT build variable has been renamed to
1858	WITH/OUT_LOADER_FIREWIRE. LOADER_{NO_,}GELI_SUPPORT has been renamed
1859	to WITH/OUT_LOADER_GELI.
1860
186120171106:
1862	The naive and non-compliant support of posix_fallocate(2) in ZFS
1863	has been removed as of r325320.  The system call now returns EINVAL
1864	when used on a ZFS file.  Although the new behavior complies with the
1865	standard, some consumers are not prepared to cope with it.
1866	One known victim is lld prior to r325420.
1867
186820171102:
1869	Building in a FreeBSD src checkout will automatically create object
1870	directories now rather than store files in the current directory if
1871	'make obj' was not ran.  Calling 'make obj' is no longer necessary.
1872	This feature can be disabled by setting WITHOUT_AUTO_OBJ=yes in
1873	/etc/src-env.conf (not /etc/src.conf), or passing the option in the
1874	environment.
1875
187620171101:
1877	The default MAKEOBJDIR has changed from /usr/obj/<srcdir> for native
1878	builds, and /usr/obj/<arch>/<srcdir> for cross-builds, to a unified
1879	/usr/obj/<srcdir>/<arch>.  This behavior can be changed to the old
1880	format by setting WITHOUT_UNIFIED_OBJDIR=yes in /etc/src-env.conf,
1881	the environment, or with -DWITHOUT_UNIFIED_OBJDIR when building.
1882	The UNIFIED_OBJDIR option is a transitional feature that will be
1883	removed for 12.0 release; please migrate to the new format for any
1884	tools by looking up the OBJDIR used by 'make -V .OBJDIR' means rather
1885	than hardcoding paths.
1886
188720171028:
1888	The native-xtools target no longer installs the files by default to the
1889	OBJDIR.  Use the native-xtools-install target with a DESTDIR to install
1890	to ${DESTDIR}/${NXTP} where NXTP defaults to /nxb-bin.
1891
189220171021:
1893	As part of the boot loader infrastructure cleanup, LOADER_*_SUPPORT
1894	options are changing from controlling the build if defined / undefined
1895	to controlling the build with explicit 'yes' or 'no' values. They will
1896	shift to WITH/WITHOUT options to match other options in the system.
1897
189820171010:
1899	libstand has turned into a private library for sys/boot use only.
1900	It is no longer supported as a public interface outside of sys/boot.
1901
190220171005:
1903	The arm port has split armv6 into armv6 and armv7. armv7 is now
1904	a valid TARGET_ARCH/MACHINE_ARCH setting. If you have an armv7 system
1905	and are running a kernel from before r324363, you will need to add
1906	MACHINE_ARCH=armv7 to 'make buildworld' to do a native build.
1907
190820171003:
1909	When building multiple kernels using KERNCONF, non-existent KERNCONF
1910	files will produce an error and buildkernel will fail. Previously
1911	missing KERNCONF files silently failed giving no indication as to
1912	why, only to subsequently discover during installkernel that the
1913	desired kernel was never built in the first place.
1914
191520170912:
1916	The default serial number format for CTL LUNs has changed.  This will
1917	affect users who use /dev/diskid/* device nodes, or whose FibreChannel
1918	or iSCSI clients care about their LUNs' serial numbers.  Users who
1919	require serial number stability should hardcode serial numbers in
1920	/etc/ctl.conf .
1921
192220170912:
1923	For 32-bit arm compiled for hard-float support, soft-floating point
1924	binaries now always get their shared libraries from
1925	LD_SOFT_LIBRARY_PATH (in the past, this was only used if
1926	/usr/libsoft also existed). Only users with a hard-float ld.so, but
1927	soft-float everything else should be affected.
1928
192920170826:
1930	The geli password typed at boot is now hidden.  To restore the previous
1931	behavior, see geli(8) for configuration options.
1932
193320170825:
1934	Move PMTUD blackhole counters to TCPSTATS and remove them from bare
1935	sysctl values.  Minor nit, but requires a rebuild of both world/kernel
1936	to complete.
1937
193820170814:
1939	"make check" behavior (made in ^/head@r295380) has been changed to
1940	execute from a limited sandbox, as opposed to executing from
1941	${TESTSDIR}.
1942
1943	Behavioral changes:
1944	- The "beforecheck" and "aftercheck" targets are now specified.
1945	- ${CHECKDIR} (added in commit noted above) has been removed.
1946	- Legacy behavior can be enabled by setting
1947	  WITHOUT_MAKE_CHECK_USE_SANDBOX in src.conf(5) or the environment.
1948
1949	If the limited sandbox mode is enabled, "make check" will execute
1950	"make distribution", then install, execute the tests, and clean up the
1951	sandbox if successful.
1952
1953	The "make distribution" and "make install" targets are typically run as
1954	root to set appropriate permissions and ownership at installation time.
1955	The end-user should set "WITH_INSTALL_AS_USER" in src.conf(5) or the
1956	environment if executing "make check" with limited sandbox mode using
1957	an unprivileged user.
1958
195920170808:
1960	Since the switch to GPT disk labels, fsck for UFS/FFS has been
1961	unable to automatically find alternate superblocks. As of r322297,
1962	the information needed to find alternate superblocks has been
1963	moved to the end of the area reserved for the boot block.
1964	Filesystems created with a newfs of this vintage or later
1965	will create the recovery information. If you have a filesystem
1966	created prior to this change and wish to have a recovery block
1967	created for your filesystem, you can do so by running fsck in
1968	foreground mode (i.e., do not use the -p or -y options). As it
1969	starts, fsck will ask ``SAVE DATA TO FIND ALTERNATE SUPERBLOCKS''
1970	to which you should answer yes.
1971
197220170728:
1973	As of r321665, an NFSv4 server configuration that services
1974	Kerberos mounts or clients that do not support the uid/gid in
1975	owner/owner_group string capability, must explicitly enable
1976	the nfsuserd daemon by adding nfsuserd_enable="YES" to the
1977	machine's /etc/rc.conf file.
1978
197920170722:
1980	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 5.0.0.
1981	Please see the 20141231 entry below for information about prerequisites
1982	and upgrading, if you are not already using clang 3.5.0 or higher.
1983
198420170701:
1985	WITHOUT_RCMDS is now the default. Set WITH_RCMDS if you need the
1986	r-commands (rlogin, rsh, etc.) to be built with the base system.
1987
198820170625:
1989	The FreeBSD/powerpc platform now uses a 64-bit type for time_t.  This is
1990	a very major ABI incompatible change, so users of FreeBSD/powerpc must
1991	be careful when performing source upgrades.  It is best to run
1992	'make installworld' from an alternate root system, either a live
1993	CD/memory stick, or a temporary root partition.  Additionally, all ports
1994	must be recompiled.  powerpc64 is largely unaffected, except in the case
1995	of 32-bit compatibility.  All 32-bit binaries will be affected.
1996
199720170623:
1998	Forward compatibility for the "ino64" project have been committed. This
1999	will allow most new binaries to run on older kernels in a limited
2000	fashion.  This prevents many of the common foot-shooting actions in the
2001	upgrade as well as the limited ability to roll back the kernel across
2002	the ino64 upgrade. Complicated use cases may not work properly, though
2003	enough simpler ones work to allow recovery in most situations.
2004
200520170620:
2006	Switch back to the BSDL dtc (Device Tree Compiler). Set WITH_GPL_DTC
2007	if you require the GPL compiler.
2008
200920170619:
2010	Forward compatibility for the "ino64" project have been committed. This
2011	will allow most new binaries to run on older kernels in a limited
2012	fashion.  This prevents many of the common foot-shooting actions in the
2013	upgrade as well as the limited ability to roll back the kernel across
2014	the ino64 upgrade. Complicated use cases may not work properly, though
2015	enough simpler ones work to allow recovery in most situations.
2016
201720170618:
2018	The internal ABI used for communication between the NFS kernel modules
2019	was changed by r320085, so __FreeBSD_version was bumped to
2020	ensure all the NFS related modules are updated together.
2021
202220170617:
2023	The ABI of struct event was changed by extending the data
2024	member to 64bit and adding ext fields.  For upgrade, same
2025	precautions as for the entry 20170523 "ino64" must be
2026	followed.
2027
202820170531:
2029	The GNU roff toolchain has been removed from base. To render manpages
2030	which are not supported by mandoc(1), man(1) can fallback on GNU roff
2031	from ports (and recommends to install it).
2032	To render roff(7) documents, consider using GNU roff from ports or the
2033	heirloom doctools roff toolchain from ports via pkg install groff or
2034	via pkg install heirloom-doctools.
2035
203620170524:
2037	The ath(4) and ath_hal(4) modules now build piecemeal to allow for
2038	smaller runtime footprint builds.  This is useful for embedded systems
2039	which only require one chipset support.
2040
2041	If you load it as a module, make sure this is in /boot/loader.conf:
2042
2043	if_ath_load="YES"
2044
2045	This will load the HAL, all chip/RF backends and if_ath_pci.
2046	If you have if_ath_pci in /boot/loader.conf, ensure it is after
2047	if_ath or it will not load any HAL chipset support.
2048
2049	If you want to selectively load things (eg on cheaper ARM/MIPS
2050	platforms where RAM is at a premium) you should:
2051
2052	* load ath_hal
2053	* load the chip modules in question
2054	* load ath_rate, ath_dfs
2055	* load ath_main
2056	* load if_ath_pci and/or if_ath_ahb depending upon your particular
2057	  bus bind type - this is where probe/attach is done.
2058
2059	For further comments/feedback, poke adrian@ .
2060
206120170523:
2062	The "ino64" 64-bit inode project has been committed, which extends
2063	a number of types to 64 bits.  Upgrading in place requires care and
2064	adherence to the documented upgrade procedure.
2065
2066	If using a custom kernel configuration ensure that the
2067	COMPAT_FREEBSD11 option is included (as during the upgrade the
2068	system will be running the ino64 kernel with the existing world).
2069
2070	For the safest in-place upgrade begin by removing previous build
2071	artifacts via "rm -rf /usr/obj/*".  Then, carefully follow the full
2072	procedure documented below under the heading "To rebuild everything and
2073	install it on the current system."  Specifically, a reboot is required
2074	after installing the new kernel before installing world. While an
2075	installworld normally works by accident from multiuser after rebooting
2076	the proper kernel, there are many cases where this will fail across this
2077	upgrade and installworld from single user is required.
2078
207920170424:
2080	The NATM framework including the en(4), fatm(4), hatm(4), and
2081	patm(4) devices has been removed.  Consumers should plan a
2082	migration before the end-of-life date for FreeBSD 11.
2083
208420170420:
2085	GNU diff has been replaced by a BSD licensed diff. Some features of GNU
2086	diff has not been implemented, if those are needed a newer version of
2087	GNU diff is available via the diffutils package under the gdiff name.
2088
208920170413:
2090	As of r316810 for ipfilter, keep frags is no longer assumed when
2091	keep state is specified in a rule. r316810 aligns ipfilter with
2092	documentation in man pages separating keep frags from keep state.
2093	This allows keep state to be specified without forcing keep frags
2094	and allows keep frags to be specified independently of keep state.
2095	To maintain previous behaviour, also specify keep frags with
2096	keep state (as documented in ipf.conf.5).
2097
209820170407:
2099	arm64 builds now use the base system LLD 4.0.0 linker by default,
2100	instead of requiring that the aarch64-binutils port or package be
2101	installed. To continue using aarch64-binutils, set
2102	CROSS_BINUTILS_PREFIX=/usr/local/aarch64-freebsd/bin .
2103
210420170405:
2105	The UDP optimization in entry 20160818 that added the sysctl
2106	net.inet.udp.require_l2_bcast has been reverted.  L2 broadcast
2107	packets will no longer be treated as L3 broadcast packets.
2108
210920170331:
2110	Binds and sends to the loopback addresses, IPv6 and IPv4, will now
2111	use any explicitly assigned loopback address available in the jail
2112	instead of using the first assigned address of the jail.
2113
211420170329:
2115	The ctl.ko module no longer implements the iSCSI target frontend:
2116	cfiscsi.ko does instead.
2117
2118	If building cfiscsi.ko as a kernel module, the module can be loaded
2119	via one of the following methods:
2120	- `cfiscsi_load="YES"` in loader.conf(5).
2121	- Add `cfiscsi` to `$kld_list` in rc.conf(5).
2122	- ctladm(8)/ctld(8), when compiled with iSCSI support
2123	  (`WITH_ISCSI=yes` in src.conf(5))
2124
2125	Please see cfiscsi(4) for more details.
2126
212720170316:
2128	The mmcsd.ko module now additionally depends on geom_flashmap.ko.
2129	Also, mmc.ko and mmcsd.ko need to be a matching pair built from the
2130	same source (previously, the dependency of mmcsd.ko on mmc.ko was
2131	missing, but mmcsd.ko now will refuse to load if it is incompatible
2132	with mmc.ko).
2133
213420170315:
2135	The syntax of ipfw(8) named states was changed to avoid ambiguity.
2136	If you have used named states in the firewall rules, you need to modify
2137	them after installworld and before rebooting. Now named states must
2138	be prefixed with colon.
2139
214020170311:
2141	The old drm (sys/dev/drm/) drivers for i915 and radeon have been
2142	removed as the userland we provide cannot use them. The KMS version
2143	(sys/dev/drm2) supports the same hardware.
2144
214520170302:
2146	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 4.0.0.
2147	Please see the 20141231 entry below for information about prerequisites
2148	and upgrading, if you are not already using clang 3.5.0 or higher.
2149
215020170221:
2151	The code that provides support for ZFS .zfs/ directory functionality
2152	has been reimplemented.  It's not possible now to create a snapshot
2153	by mkdir under .zfs/snapshot/.  That should be the only user visible
2154	change.
2155
215620170216:
2157	EISA bus support has been removed. The WITH_EISA option is no longer
2158	valid.
2159
216020170215:
2161	MCA bus support has been removed.
2162
216320170127:
2164	The WITH_LLD_AS_LD / WITHOUT_LLD_AS_LD build knobs have been renamed
2165	WITH_LLD_IS_LD / WITHOUT_LLD_IS_LD, for consistency with CLANG_IS_CC.
2166
216720170112:
2168	The EM_MULTIQUEUE kernel configuration option is deprecated now that
2169	the em(4) driver conforms to iflib specifications.
2170
217120170109:
2172	The igb(4), em(4) and lem(4) ethernet drivers are now implemented via
2173	IFLIB.  If you have a custom kernel configuration that excludes em(4)
2174	but you use igb(4), you need to re-add em(4) to your custom
2175	configuration.
2176
217720161217:
2178	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.1.
2179	Please see the 20141231 entry below for information about prerequisites
2180	and upgrading, if you are not already using clang 3.5.0 or higher.
2181
218220161124:
2183	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.0.
2184	Please see the 20141231 entry below for information about prerequisites
2185	and upgrading, if you are not already using clang 3.5.0 or higher.
2186
218720161119:
2188	The layout of the pmap structure has changed for powerpc to put the pmap
2189	statistics at the front for all CPU variations.  libkvm(3) and all tools
2190	that link against it need to be recompiled.
2191
219220161030:
2193	isl(4) and cyapa(4) drivers now require a new driver,
2194	chromebook_platform(4), to work properly on Chromebook-class hardware.
2195	On other types of hardware the drivers may need to be configured using
2196	device hints.  Please see the corresponding manual pages for details.
2197
219820161017:
2199	The urtwn(4) driver was merged into rtwn(4) and now consists of
2200	rtwn(4) main module + rtwn_usb(4) and rtwn_pci(4) bus-specific
2201	parts.
2202	Also, firmware for RTL8188CE was renamed due to possible name
2203	conflict (rtwnrtl8192cU(B) -> rtwnrtl8192cE(B))
2204
220520161015:
2206	GNU rcs has been removed from base.  It is available as packages:
2207	- rcs: Latest GPLv3 GNU rcs version.
2208	- rcs57: Copy of the latest version of GNU rcs (GPLv2) before it was
2209	removed from base.
2210
221120161008:
2212	Use of the cc_cdg, cc_chd, cc_hd, or cc_vegas congestion control
2213	modules now requires that the kernel configuration contain the
2214	TCP_HHOOK option. (This option is included in the GENERIC kernel.)
2215
221620161003:
2217	The WITHOUT_ELFCOPY_AS_OBJCOPY src.conf(5) knob has been retired.
2218	ELF Tool Chain's elfcopy is always installed as /usr/bin/objcopy.
2219
222020160924:
2221	Relocatable object files with the extension of .So have been renamed
2222	to use an extension of .pico instead.  The purpose of this change is
2223	to avoid a name clash with shared libraries on case-insensitive file
2224	systems.  On those file systems, foo.So is the same file as foo.so.
2225
222620160918:
2227	GNU rcs has been turned off by default.  It can (temporarily) be built
2228	again by adding WITH_RCS knob in src.conf.
2229	Otherwise, GNU rcs is available from packages:
2230	- rcs: Latest GPLv3 GNU rcs version.
2231	- rcs57: Copy of the latest version of GNU rcs (GPLv2) from base.
2232
223320160918:
2234	The backup_uses_rcs functionality has been removed from rc.subr.
2235
223620160908:
2237	The queue(3) debugging macro, QUEUE_MACRO_DEBUG, has been split into
2238	two separate components, QUEUE_MACRO_DEBUG_TRACE and
2239	QUEUE_MACRO_DEBUG_TRASH.  Define both for the original
2240	QUEUE_MACRO_DEBUG behavior.
2241
224220160824:
2243	r304787 changed some ioctl interfaces between the iSCSI userspace
2244	programs and the kernel.  ctladm, ctld, iscsictl, and iscsid must be
2245	rebuilt to work with new kernels.  __FreeBSD_version has been bumped
2246	to 1200005.
2247
224820160818:
2249	The UDP receive code has been updated to only treat incoming UDP
2250	packets that were addressed to an L2 broadcast address as L3
2251	broadcast packets.  It is not expected that this will affect any
2252	standards-conforming UDP application.  The new behaviour can be
2253	disabled by setting the sysctl net.inet.udp.require_l2_bcast to
2254	0.
2255
225620160818:
2257	Remove the openbsd_poll system call.
2258	__FreeBSD_version has been bumped because of this.
2259
226020160708:
2261	The stable/11 branch has been created from head@r302406.
2262
2263After branch N is created, entries older than the N-2 branch point are removed
2264from this file. After stable/14 is branched and current becomes FreeBSD 15,
2265entries older than stable/12 branch point will be removed from current's
2266UPDATING file.
2267
2268COMMON ITEMS:
2269
2270	General Notes
2271	-------------
2272	Sometimes, obscure build problems are the result of environment
2273	poisoning.  This can happen because the make utility reads its
2274	environment when searching for values for global variables.  To run
2275	your build attempts in an "environmental clean room", prefix all make
2276	commands with 'env -i '.  See the env(1) manual page for more details.
2277	Occasionally a build failure will occur with "make -j" due to a race
2278	condition.  If this happens try building again without -j, and please
2279	report a bug if it happens consistently.
2280
2281	When upgrading from one major version to another it is generally best to
2282	upgrade to the latest code in the currently installed branch first, then
2283	do an upgrade to the new branch. This is the best-tested upgrade path,
2284	and has the highest probability of being successful.  Please try this
2285	approach if you encounter problems with a major version upgrade.  Since
2286	the stable 4.x branch point, one has generally been able to upgrade from
2287	anywhere in the most recent stable branch to head / current (or even the
2288	last couple of stable branches). See the top of this file when there's
2289	an exception.
2290
2291	The update process will emit an error on an attempt to perform a build
2292	or install from a FreeBSD version below the earliest supported version.
2293	When updating from an older version the update should be performed one
2294	major release at a time, including running `make delete-old` at each
2295	step.
2296
2297	When upgrading a live system, having a root shell around before
2298	installing anything can help undo problems. Not having a root shell
2299	around can lead to problems if pam has changed too much from your
2300	starting point to allow continued authentication after the upgrade.
2301
2302	This file should be read as a log of events. When a later event changes
2303	information of a prior event, the prior event should not be deleted.
2304	Instead, a pointer to the entry with the new information should be
2305	placed in the old entry. Readers of this file should also sanity check
2306	older entries before relying on them blindly. Authors of new entries
2307	should write them with this in mind.
2308
2309	ZFS notes
2310	---------
2311	When upgrading the boot ZFS pool to a new version (via zpool upgrade),
2312	always follow these three steps:
2313
2314	1) recompile and reinstall the ZFS boot loader and boot block
2315	(this is part of "make buildworld" and "make installworld")
2316
2317	2) update the ZFS boot block on your boot drive (only required when
2318	doing a zpool upgrade):
2319
2320	When booting on x86 via BIOS, use the following to update the ZFS boot
2321	block on the freebsd-boot partition of a GPT partitioned drive ada0:
2322		gpart bootcode -p /boot/gptzfsboot -i $N ada0
2323	The value $N will typically be 1.  For EFI booting, see EFI notes.
2324
2325	3) zpool upgrade the root pool. New bootblocks will work with old
2326	pools, but not vice versa, so they need to be updated before any
2327	zpool upgrade.
2328
2329	Non-boot pools do not need these updates.
2330
2331	EFI notes
2332	---------
2333
2334	There are two locations the boot loader can be installed into. The
2335	current location (and the default) is \efi\freebsd\loader.efi and using
2336	efibootmgr(8) to configure it. The old location, that must be used on
2337	deficient systems that don't honor efibootmgr(8) protocols, is the
2338	fallback location of \EFI\BOOT\BOOTxxx.EFI. Generally, you will copy
2339	/boot/loader.efi to this location, but on systems installed a long time
2340	ago the ESP may be too small and /boot/boot1.efi may be needed unless
2341	the ESP has been expanded in the meantime.
2342
2343	Recent systems will have the ESP mounted on /boot/efi, but older ones
2344	may not have it mounted at all, or mounted in a different
2345	location. Older arm SD images with MBR used /boot/msdos as the
2346	mountpoint. The ESP is a MSDOS filesystem.
2347
2348	The EFI boot loader rarely needs to be updated. For ZFS booting,
2349	however, you must update loader.efi before you do 'zpool upgrade' the
2350	root zpool, otherwise the old loader.efi may reject the upgraded zpool
2351	since it does not automatically understand some new features.
2352
2353	See loader.efi(8) and uefi(8) for more details.
2354
2355	To build a kernel
2356	-----------------
2357	If you are updating from a prior version of FreeBSD (even one just
2358	a few days old), you should follow this procedure.  It is the most
2359	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
2360
2361	make kernel-toolchain
2362	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
2363	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
2364
2365	If you are running kernel modules from ports, see FOOTNOTE [1].
2366
2367	To test a kernel once
2368	---------------------
2369	If you just want to boot a kernel once (because you are not sure
2370	if it works, or if you want to boot a known bad kernel to provide
2371	debugging information) run
2372	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
2373	nextboot -k testkernel
2374
2375	To rebuild everything and install it on the current system.
2376	-----------------------------------------------------------
2377	# Note: sometimes if you are running current you gotta do more than
2378	# is listed here if you are upgrading from a really old current.
2379
2380	<make sure you have good level 0 dumps>		[2]
2381	make buildworld
2382	<make sure any needed PORTS_MODULES are set>	[1]
2383	make buildkernel KERNCONF=YOUR_KERNEL_HERE
2384	make installkernel KERNCONF=YOUR_KERNEL_HERE
2385	<reboot in single user>				[3]
2386	etcupdate -p					[5]
2387	make installworld
2388	etcupdate -B					[4]
2389	make delete-old					[6]
2390	<reboot>
2391
2392	To cross-install current onto a separate partition
2393	--------------------------------------------------
2394	# In this approach we use a separate partition to hold
2395	# current's root, 'usr', and 'var' directories.   A partition
2396	# holding "/", "/usr" and "/var" should be about 2GB in
2397	# size.
2398
2399	<make sure you have good level 0 dumps>
2400	<boot into -stable>
2401	make buildworld
2402	make buildkernel KERNCONF=YOUR_KERNEL_HERE	[1]
2403	<maybe newfs current's root partition>
2404	<mount current's root partition on directory ${CURRENT_ROOT}>
2405	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
2406	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
2407	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
2408	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
2409	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
2410	<reboot into current>
2411	<do a "native" rebuild/install as described in the previous section>
2412	<maybe install compatibility libraries from ports/misc/compat*>
2413	<reboot>
2414
2415
2416	To upgrade in-place from stable to current
2417	----------------------------------------------
2418	<make sure you have good level 0 dumps>		[2]
2419	make buildworld					[9]
2420	<make sure any needed PORTS_MODULES are set>	[1]
2421	make buildkernel KERNCONF=YOUR_KERNEL_HERE	[8]
2422	make installkernel KERNCONF=YOUR_KERNEL_HERE
2423	<reboot in single user>				[3]
2424	etcupdate -p					[5]
2425	make installworld
2426	etcupdate -B					[4]
2427	make delete-old					[6]
2428	<reboot>
2429
2430	Make sure that you've read the UPDATING file to understand the
2431	tweaks to various things you need.  At this point in the life
2432	cycle of current, things change often and you are on your own
2433	to cope.  The defaults can also change, so please read ALL of
2434	the UPDATING entries.
2435
2436	Also, if you are tracking -current, you must be subscribed to
2437	freebsd-current@freebsd.org.  Make sure that before you update
2438	your sources that you have read and understood all the recent
2439	messages there.  If in doubt, please track -stable which has
2440	much fewer pitfalls.
2441
2442FOOTNOTES:
2443
2444	[1] If you have third party modules, such as drm-kmod or vmware, you
2445	should disable them at this point so they don't crash your system on
2446	reboot. Alternatively, you should rebuild all the modules you have in
2447	your system and install them as well.  If you are running -current, you
2448	should seriously consider placing all sources to all the modules for
2449	your system (or symlinks to them) in /usr/local/sys/modules so this
2450	happens automatically. If all your modules come from ports, then adding
2451	the port origin directories to PORTS_MODULES instead is also automatic
2452	and effective, eg:
2453	     PORTS_MODULES+=graphics/drm-kmod graphics/nvidia-drm-kmod
2454
2455	[2] To make complete dumps on zfs(4), use bectl(8), which
2456	creates bootable snapshots of configurable depth that are
2457	selectable via the bootloader. For ufs(4), use dump(8) and
2458	restore(8).
2459
2460	[3] From the bootblocks, boot -s, and then do
2461		fsck -p
2462		mount -u /
2463		mount -a
2464		sh /etc/rc.d/zfs start	# mount zfs filesystem, if needed
2465		cd src			# full path to source
2466		adjkerntz -i		# if CMOS is wall time
2467	Also, when doing a major release upgrade, it is required that you boot
2468	into single user mode to do the installworld.
2469
2470	[4] Note: This step is non-optional.  Failure to do this step
2471	can result in a significant reduction in the functionality of the
2472	system.  Attempting to do it by hand is not recommended and those
2473	that pursue this avenue should read this file carefully, as well
2474	as the archives of freebsd-current and freebsd-hackers mailing lists
2475	for potential gotchas.  See etcupdate(8) for more information.
2476
2477	[5] Usually this step is a no-op.  However, from time to time
2478	you may need to do this if you get unknown user in the following
2479	step.
2480
2481	[6] This only deletes old files and directories. Old libraries
2482	can be deleted by "make delete-old-libs", but you have to make
2483	sure that no program is using those libraries anymore.
2484
2485	[8] The new kernel must be able to run existing binaries used by an
2486	installworld.  When upgrading across major versions, the new kernel's
2487	configuration must include the correct COMPAT_FREEBSD<n> option for
2488	existing binaries (e.g. COMPAT_FREEBSD11 to run 11.x binaries).  Failure
2489	to do so may leave you with a system that is hard to boot to recover. A
2490	GENERIC kernel will include suitable compatibility options to run
2491	binaries from older branches.  Note that the ability to run binaries
2492	from unsupported branches is not guaranteed.
2493
2494	Make sure that you merge any new devices from GENERIC since the
2495	last time you updated your kernel config file. Options also
2496	change over time, so you may need to adjust your custom kernels
2497	for these as well.
2498
2499	[9] If CPUTYPE is defined in your /etc/make.conf, make sure to use the
2500	"?=" instead of the "=" assignment operator, so that buildworld can
2501	override the CPUTYPE if it needs to.
2502
2503	MAKEOBJDIRPREFIX must be defined in an environment variable, and
2504	not on the command line, or in /etc/make.conf.  buildworld will
2505	warn if it is improperly defined.
2506FORMAT:
2507
2508This file contains a list, in reverse chronological order, of major
2509breakages in tracking -current.  It is not guaranteed to be a complete
2510list of such breakages, and only contains entries since September 23, 2011.
2511If you need to see UPDATING entries from before that date, you will need
2512to fetch an UPDATING file from an older FreeBSD release.
2513
2514Copyright information:
2515
2516Copyright 1998-2009 M. Warner Losh <imp@FreeBSD.org>
2517
2518Redistribution, publication, translation and use, with or without
2519modification, in full or in part, in any form or format of this
2520document are permitted without further permission from the author.
2521
2522THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
2523IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
2524WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
2525DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
2526INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
2527(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
2528SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2529HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
2530STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
2531IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2532POSSIBILITY OF SUCH DAMAGE.
2533
2534Contact Warner Losh if you have any questions about your use of
2535this document.
2536