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