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