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