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