xref: /freebsd/UPDATING (revision b59851e99c20f3a72c34bdf9919e3bf49b894e4e)
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://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
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
3020210426:
31	Commit 875977314881 changed the internal KAPI between
32	the nfsd and nfscommon modules.  As such these modules
33	need to be rebuilt from sources.
34	Without this patch in your NFSv4.1/4.2 server, enabling
35	delegations by setting vfs.nfsd.issue_delegations non-zero
36	is not recommended.
37
3820210411:
39	Commit 7763814fc9c2 changed the internal KAPI between
40	the krpc and NFS.  As such, the krpc, nfscommon and
41	nfscl modules must all be rebuilt from sources.
42	Without this patch, NFSv4.1/4.2 mounts should not
43	be done with the nfscbd(8) daemon running, to avoid
44	needing a working back channel for server->client RPCs.
45
4620210330:
47	Commit 01ae8969a9ee fixed the NFSv4.1/4.2 server so that it
48	handles binding of the back channel as required by RFC5661.
49	Until this patch is in your server, avoid use of the "nconnects"
50	mount option for Linux NFSv4.1/4.2 mounts.
51
5220210225:
53	For 64-bit architectures the base system is now built with Position
54	Independent Executable (PIE) support enabled by default.  It may be
55	disabled using the WITHOUT_PIE knob.  A clean build is required.
56
5720210128:
58	Various LinuxKPI functionality was added which conflicts with DRM.
59	Please update your drm-kmod port to after the __FreeBSD_verison 1400003
60	update.
61
6220210108:
63	PC Card attachments for all devices have been removed. In the case of
64	wi and cmx, the entire drivers were removed because they were only
65	PC Card devices. FreeBSD_version 1300134 should be used for this
66	since it was bumped so recently.
67
6820210107:
69	Transport-independent parts of HID support have been split off the USB
70	code in to separate subsystem.  Kernel configs which include one of
71	ums, ukbd, uhid, atp, wsp, wmt, uaudio, ugold or ucycom drivers should
72	be updated with adding of "device hid" line.
73
7420210105:
75	ncurses installation has been modified to only keep the widechar
76	enabled version.  Incremental build is broken for that change, so it
77	requires a clean build.
78
7920201223:
80	The FreeBSD project has migrated from Subversion to Git. Temporary
81	instructions can be found at
82	https://github.com/bsdimp/freebsd-git-docs/blob/main/src-cvt.md
83	and other documents in that repo.
84
8520201216:
86	The services database has been updated to cover more of the basic
87	services expected in a modern system. The database is big enough
88	that it will cause issues in mergemaster in Releases previous to
89	12.2 and 11.3, or in very old current systems from before r358154.
90
9120201215:
92	Obsolete in-tree GDB 6.1.1 has been removed.  GDB (including kgdb)
93	may be installed from ports or packages.
94
9520201124:
96	ping6 has been merged into ping.  It can now be called as "ping -6".
97	See ping(8) for details.
98
9920201108:
100	Default value of net.add_addr_allfibs has been changed to 0.
101	If you have multi-fib configuration and rely on existence of all
102	interface routes in every fib, you need to set the above sysctl to 1.
103
10420201030:
105	The internal pre-processor in the calendar(1) program has been
106	extended to support more C pre-processor commands (e.g. #ifdef, #else,
107	and #undef) and to detect unbalanced conditional statements.
108	Error messages have been extended to include the filename and line
109	number if processing stops to help fixing malformed data files.
110
11120201026:
112	All the data files for the calendar(1) program, except calendar.freebsd,
113	have been moved to the deskutils/calendar-data port, much like the
114	jewish calendar entries were moved to deskutils/hebcal years ago. After
115	make delete-old-files, you need to install it to retain full
116	functionality. calendar(1) will issue a reminder for files it can't
117	find.
118
11920200923:
120	LINT files are no longer generated. We now include the relevant NOTES
121	files. Note: This may cause conflicts with updating in some cases.
122	        find sys -name LINT\* -delete
123	is suggested across this commit	to remove the generated	LINT files.
124
125	If you have tried to update with generated files there, the svn
126	command you want to un-auger the tree is
127		cd sys/amd64/conf
128		svn revert -R .
129	and then do the above find from the top level. Substitute 'amd64'
130	above with where the error message indicates a conflict.
131
13220200824:
133	OpenZFS support has been integrated. Do not upgrade root pools until
134	the loader is updated to support zstd. Furthermore, we caution against
135	'zpool upgrade' for the next few weeks. The change should be transparent
136	unless you  want to use new features.
137
138	Not all "NO_CLEAN" build scenarios work across these changes. Many
139	scenarios have been tested and fixed, but rebuilding kernels without
140	rebuilding world may fail.
141
142	The ZFS cache file has moved from /boot to /etc to match the OpenZFS
143	upstream default. A fallback to /boot has been added for mountroot.
144
145	Pool auto import behavior at boot has been moved from the kernel module
146	to an explicit "zpool import -a" in one of the rc scripts enabled by
147	zfs_enable=YES. This means your non-root zpools won't auto import until
148	you upgrade your /etc/rc.d files.
149
15020200824:
151	The resume code now notifies devd with the 'kernel' system
152	rather than the old 'kern' subsystem to be consistent with
153	other use. The old notification will be created as well, but
154	will be removed prior to FreeBSD 14.0.
155
15620200821:
157	r362275 changed the internal API between the kernel RPC and the
158	NFS modules. As such, all the modules must be recompiled from
159	sources.
160
16120200817:
162	r364330 modified the internal API used between the NFS modules.
163	As such, all the NFS modules must be re-compiled from sources.
164
16520200816:
166	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
167	been upgraded to 11.0.0.  Please see the 20141231 entry below for
168	information about prerequisites and upgrading, if you are not already
169	using clang 3.5.0 or higher.
170
17120200810:
172	r364092 modified the internal ABI used between the kernel NFS
173	modules.  As such, all of these modules need to be rebuilt
174	from sources, so a version bump was done.
175
17620200807:
177	Makefile.inc has been updated to work around the issue documented in
178	20200729. It was a case where the optimization of using symbolic links
179	to point to binaries created a situation where we'd run new binaries
180	with old libraries starting midway through the installworld process.
181
18220200729:
183	r363679 has redefined some undefined behavior in regcomp(3); notably,
184	extraneous escapes of most ordinary characters will no longer be
185	accepted.  An exp-run has identified all of the problems with this in
186	ports, but other non-ports software may need extra escapes removed to
187	continue to function.
188
189	Because of this change, installworld may encounter the following error
190	from rtld: Undefined symbol "regcomp@FBSD_1.6" -- It is imperative that
191	you do not halt installworld. Instead, let it run to completion (whether
192	successful or not) and run installworld once more.
193
19420200627:
195	A new implementation of bc and dc has been imported in r362681. This
196	implementation corrects non-conformant behavior of the previous bc
197	and adds GNU bc compatible options. It offers a number of extensions,
198	is much faster on large values, and has support for message catalogs
199	(a number of languages are already supported, contributions of further
200	languages welcome). The option WITHOUT_GH_BC can be used to build the
201	world with the previous versions of bc and dc.
202
20320200625:
204	r362639 changed the internal API used between the NFS kernel modules.
205	As such, they all need to be rebuilt from sources.
206
20720200613:
208	r362158 changed the arguments for VFS_CHECKEXP().  As such, any
209	out of tree file systems need to be modified and rebuilt.
210	Also, any file systems that are modules must be rebuilt.
211
21220200604:
213	read(2) of a directory fd is now rejected by default.  root may
214	re-enable it for system root only on non-ZFS filesystems with the
215	security.bsd.allow_read_dir sysctl(8) MIB if
216	security.bsd.suser_enabled=1.
217
218	It may be advised to setup aliases for grep to default to `-d skip` if
219	commonly non-recursively grepping a list that includes directories and
220	the potential for the resulting stderr output is not tolerable.  Example
221	aliases are now installed, commented out, in /root/.cshrc and
222	/root/.shrc.
223
22420200523:
225	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
226	been upgraded to 10.0.1.  Please see the 20141231 entry below for
227	information about prerequisites and upgrading, if you are not already
228	using clang 3.5.0 or higher.
229
23020200512:
231	Support for obsolete compilers has been removed from the build system.
232	Clang 6 and GCC 6.4 are the minimum supported versions.
233
23420200424:
235	closefrom(2) has been moved under COMPAT12, and replaced in libc with a
236	stub that calls close_range(2).  If using a custom kernel configuration,
237	you may want to ensure that the COMPAT_FREEBSD12 option is included, as
238	a slightly older -CURRENT userland and older FreeBSD userlands may not
239	be functional without closefrom(2).
240
24120200414:
242	Upstream DTS from Linux 5.6 was merged and they now have the SID
243	and THS (Secure ID controller and THermal Sensor) node present.
244	The DTB overlays have now been removed from the tree for the H3/H5 and
245	A64 SoCs and the aw_sid and aw_thermal driver have been updated to
246	deal with upstream DTS. If you are using those overlays you need to
247	remove them from loader.conf and update the DTBs on the FAT partition.
248
24920200310:
250	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
251	been upgraded to 10.0.0.  Please see the 20141231 entry below for
252	information about prerequisites and upgrading, if you are not already
253	using clang 3.5.0 or higher.
254
25520200309:
256	The amd(8) automount daemon has been removed from the source tree.
257	As of FreeBSD 10.1 autofs(5) is the preferred tool for automounting.
258	amd is still available in the sysutils/am-utils port.
259
26020200301:
261	Removed brooktree driver (bktr.4) from the tree.
262
26320200229:
264	The WITH_GPL_DTC option has been removed.  The BSD-licenced device tree
265	compiler in usr.bin/dtc is used on all architectures which use dtc, and
266	the GPL dtc is available (if needed) from the sysutils/dtc port.
267
26820200229:
269	The WITHOUT_LLVM_LIBUNWIND option has been removed.  LLVM's libunwind
270	is used by all supported CPU architectures.
271
27220200229:
273	GCC 4.2.1 has been removed from the tree.  The WITH_GCC,
274	WITH_GCC_BOOTSTRAP, and WITH_GNUCXX options are no longer available.
275	Users who wish to build FreeBSD with GCC must use the external toolchain
276	ports or packages.
277
27820200220:
279	ncurses has been updated to a newer version (6.2-20200215). Given the ABI
280	has changed, users will have to rebuild all the ports that are linked to
281	ncurses.
282
28320200217:
284	The size of struct vnet and the magic cookie have changed.
285	Users need to recompile libkvm and all modules using VIMAGE
286	together with their new kernel.
287
28820200212:
289	Defining the long deprecated NO_CTF, NO_DEBUG_FILES, NO_INSTALLLIB,
290	NO_MAN, NO_PROFILE, and NO_WARNS variables is now an error.  Update
291	your Makefiles and scripts to define MK_<var>=no instead as required.
292
293	One exception to this is that program or library Makefiles should
294	define MAN to empty rather than setting MK_MAN=no.
295
29620200108:
297	Clang/LLVM is now the default compiler and LLD the default
298	linker for riscv64.
299
30020200107:
301	make universe no longer uses GCC 4.2.1 on any architectures.
302	Architectures not supported by in-tree Clang/LLVM require an
303	external toolchain package.
304
30520200104:
306	GCC 4.2.1 is now not built by default, as part of the GCC 4.2.1
307	retirement plan.  Specifically, the GCC, GCC_BOOTSTRAP, and GNUCXX
308	options default to off for all supported CPU architectures.  As a
309	short-term transition aid they may be enabled via WITH_* options.
310	GCC 4.2.1 is expected to be removed from the tree on 2020-03-31.
311
31220200102:
313	Support for armv5 has been disconnected and is being removed. The
314	machine combination MACHINE=arm MACHINE_ARCH=arm is no longer valid.
315	You must now use a MACHINE_ARCH of armv6 or armv7. The default
316	MACHINE_ARCH for MACHINE=arm is now armv7.
317
31820191226:
319	Clang/LLVM is now the default compiler for all powerpc architectures.
320	LLD is now the default linker for powerpc64.  The change for powerpc64
321	also includes a change to the ELFv2 ABI, incompatible with the existing
322	ABI.
323
32420191226:
325	Kernel-loadable random(4) modules are no longer unloadable.
326
32720191222:
328	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
329	been upgraded to 9.0.1.  Please see the 20141231 entry below for
330	information about prerequisites and upgrading, if you are not already
331	using clang 3.5.0 or higher.
332
33320191212:
334	r355677 has modified the internal interface used between the
335	NFS modules in the kernel. As such, they must all be upgraded
336	simultaneously. I will do a version bump for this.
337
33820191205:
339	The root certificates of the Mozilla CA Certificate Store have been
340	imported into the base system and can be managed with the certctl(8)
341	utility.  If you have installed the security/ca_root_nss port or package
342	with the ETCSYMLINK option (the default), be advised that there may be
343	differences between those included in the port and those included in
344	base due to differences in nss branch used as well as general update
345	frequency.  Note also that certctl(8) cannot manage certs in the
346	format used by the security/ca_root_nss port.
347
34820191120:
349	The amd(8) automount daemon has been disabled by default, and will be
350	removed in the future.  As of FreeBSD 10.1 the autofs(5) is available
351	for automounting.
352
35320191107:
354	The nctgpio and wbwd drivers have been moved to the superio bus.
355	If you have one of these drivers in a kernel configuration, then
356	you should add device superio to it.  If you use one of these drivers
357	as a module and you compile a custom set of modules, then you should
358	add superio to the set.
359
36020191021:
361	KPIs for network drivers to access interface addresses have changed.
362	Users need to recompile NIC driver modules together with kernel.
363
36420191021:
365	The net.link.tap.user_open sysctl no longer prevents user opening of
366	already created /dev/tapNN devices.  Access is still controlled by
367	node permissions, just like tun devices.  The net.link.tap.user_open
368	sysctl is now used only to allow users to perform devfs cloning of
369	tap devices, and the subsequent open may not succeed if the user is not
370	in the appropriate group.  This sysctl may be deprecated/removed
371	completely in the future.
372
37320191009:
374	mips, powerpc, and sparc64 are no longer built as part of
375	universe / tinderbox unless MAKE_OBSOLETE_GCC is defined. If
376	not defined, mips, powerpc, and sparc64 builds will look for
377	the xtoolchain binaries and if installed use them for universe
378	builds. As llvm 9.0 becomes vetted for these architectures, they
379	will be removed from the list.
380
38120191009:
382	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
383	been upgraded to 9.0.0.  Please see the 20141231 entry below for
384	information about prerequisites and upgrading, if you are not already
385	using clang 3.5.0 or higher.
386
38720191003:
388	The hpt27xx, hptmv, hptnr, and hptrr drivers have been removed from
389	GENERIC.  They are available as modules and can be loaded by adding
390	to /boot/loader.conf hpt27xx_load="YES", hptmv_load="YES",
391	hptnr_load="YES", or hptrr_load="YES", respectively.
392
39320190913:
394	ntpd no longer by default locks its pages in memory, allowing them
395	to be paged out by the kernel. Use rlimit memlock to restore
396	historic BSD behaviour. For example, add "rlimit memlock 32"
397	to ntp.conf to lock up to 32 MB of ntpd address space in memory.
398
39920190823:
400	Several of ping6's options have been renamed for better consistency
401	with ping.  If you use any of -ARWXaghmrtwx, you must update your
402	scripts.  See ping6(8) for details.
403
40420190727:
405	The vfs.fusefs.sync_unmount and vfs.fusefs.init_backgrounded sysctls
406	and the "-o sync_unmount" and "-o init_backgrounded" mount options have
407	been removed from mount_fusefs(8).  You can safely remove them from
408	your scripts, because they had no effect.
409
410	The vfs.fusefs.fix_broken_io, vfs.fusefs.sync_resize,
411	vfs.fusefs.refresh_size, vfs.fusefs.mmap_enable,
412	vfs.fusefs.reclaim_revoked, and vfs.fusefs.data_cache_invalidate
413	sysctls have been removed.  If you felt the need to set any of them to
414	a non-default value, please tell asomers@FreeBSD.org why.
415
41620190713:
417	Default permissions on the /var/account/acct file (and copies of it
418	rotated by periodic daily scripts) are changed from 0644 to 0640
419	because the file contains sensitive information that should not be
420	world-readable.  If the /var/account directory must be created by
421	rc.d/accounting, the mode used is now 0750.  Admins who use the
422	accounting feature are encouraged to change the mode of an existing
423	/var/account directory to 0750 or 0700.
424
42520190620:
426	Entropy collection and the /dev/random device are no longer optional
427	components.  The "device random" option has been removed.
428	Implementations of distilling algorithms can still be made loadable
429	with "options RANDOM_LOADABLE" (e.g., random_fortuna.ko).
430
43120190612:
432	Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
433	been upgraded to 8.0.1.  Please see the 20141231 entry below for
434	information about prerequisites and upgrading, if you are not already
435	using clang 3.5.0 or higher.
436
43720190608:
438	A fix was applied to i386 kernel modules to avoid panics with
439	dpcpu or vnet.  Users need to recompile i386 kernel modules
440	having pcpu or vnet sections or they will refuse to load.
441
44220190513:
443	User-wired pages now have their own counter,
444	vm.stats.vm.v_user_wire_count.  The vm.max_wired sysctl was renamed
445	to vm.max_user_wired and changed from an unsigned int to an unsigned
446	long.  bhyve VMs wired with the -S are now subject to the user
447	wiring limit; the vm.max_user_wired sysctl may need to be tuned to
448	avoid running into the limit.
449
45020190507:
451	The IPSEC option has been removed from GENERIC.  Users requiring
452	ipsec(4) must now load the ipsec(4) kernel module.
453
45420190507:
455	The tap(4) driver has been folded into tun(4), and the module has been
456	renamed to tuntap.  You should update any kld_list="if_tap" or
457	kld_list="if_tun" entries in /etc/rc.conf, if_tap_load="YES" or
458	if_tun_load="YES" entries in /boot/loader.conf to load the if_tuntap
459	module instead, and "device tap" or "device tun" entries in kernel
460	config files to select the tuntap device instead.
461
46220190418:
463	The following knobs have been added related to tradeoffs between
464	safe use of the random device and availability in the absence of
465	entropy:
466
467	kern.random.initial_seeding.bypass_before_seeding: tunable; set
468	non-zero to bypass the random device prior to seeding, or zero to
469	block random requests until the random device is initially seeded.
470	For now, set to 1 (unsafe) by default to restore pre-r346250 boot
471	availability properties.
472
473	kern.random.initial_seeding.read_random_bypassed_before_seeding:
474	read-only diagnostic sysctl that is set when bypass is enabled and
475	read_random(9) is bypassed, to enable programmatic handling of this
476	initial condition, if desired.
477
478	kern.random.initial_seeding.arc4random_bypassed_before_seeding:
479	Similar to the above, but for for arc4random(9) initial seeding.
480
481	kern.random.initial_seeding.disable_bypass_warnings: tunable; set
482	non-zero to disable warnings in dmesg when the same conditions are
483	met as for the diagnostic sysctls above.  Defaults to zero, i.e.,
484	produce warnings in dmesg when the conditions are met.
485
48620190416:
487	The loadable random module KPI has changed; the random_infra_init()
488	routine now requires a 3rd function pointer for a bool (*)(void)
489	method that returns true if the random device is seeded (and
490	therefore unblocked).
491
49220190404:
493	r345895 reverts r320698. This implies that an nfsuserd(8) daemon
494	built from head sources between r320757 (July 6, 2017) and
495	r338192 (Aug. 22, 2018) will not work unless the "-use-udpsock"
496	is added to the command line.
497	nfsuserd daemons built from head sources that are post-r338192 are
498	not affected and should continue to work.
499
50020190320:
501	The fuse(4) module has been renamed to fusefs(4) for consistency with
502	other filesystems.  You should update any kld_load="fuse" entries in
503	/etc/rc.conf, fuse_load="YES" entries in /boot/loader.conf, and
504	"options FUSE" entries in kernel config files.
505
50620190304:
507	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
508	8.0.0.  Please see the 20141231 entry below for information about
509	prerequisites and upgrading, if you are not already using clang 3.5.0
510	or higher.
511
51220190226:
513	geom_uzip(4) depends on the new module xz.  If geom_uzip is statically
514	compiled into your custom kernel, add 'device xz' statement to the
515	kernel config.
516
51720190219:
518	drm and drm2 have been removed from the tree. Please see
519	https://wiki.freebsd.org/Graphics for the latest information on
520	migrating to the drm ports.
521
52220190131:
523	Iflib is no longer unconditionally compiled into the kernel.  Drivers
524	using iflib and statically compiled into the kernel, now require
525	the 'device iflib' config option.  For the same drivers loaded as
526	modules on kernels not having 'device iflib', the iflib.ko module
527	is loaded automatically.
528
52920190125:
530	The IEEE80211_AMPDU_AGE and AH_SUPPORT_AR5416 kernel configuration
531	options no longer exist since r343219 and r343427 respectively;
532	nothing uses them, so they should be just removed from custom
533	kernel config files.
534
53520181230:
536	r342635 changes the way efibootmgr(8) works by requiring users to add
537	the -b (bootnum) parameter for commands where the bootnum was previously
538	specified with each option. For example 'efibootmgr -B 0001' is now
539	'efibootmgr -B -b 0001'.
540
54120181220:
542	r342286 modifies the NFSv4 server so that it obeys vfs.nfsd.nfs_privport
543	in the same as it is applied to NFSv2 and 3.  This implies that NFSv4
544	servers that have vfs.nfsd.nfs_privport set will only allow mounts
545	from clients using a reserved port#. Since both the FreeBSD and Linux
546	NFSv4 clients use reserved port#s by default, this should not affect
547	most NFSv4 mounts.
548
54920181219:
550	The XLP config has been removed. We can't support 64-bit atomics in this
551	kernel because it is running in 32-bit mode. XLP users must transition
552	to running a 64-bit kernel (XLP64 or XLPN32).
553
554	The mips GXEMUL support has been removed from FreeBSD. MALTA* + qemu is
555	the preferred emulator today and we don't need two different ones.
556
557	The old sibyte / swarm / Broadcom BCM1250 support has been
558	removed from the mips port.
559
56020181211:
561	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
562	7.0.1.  Please see the 20141231 entry below for information about
563	prerequisites and upgrading, if you are not already using clang 3.5.0
564	or higher.
565
56620181211:
567	Remove the timed and netdate programs from the base tree.  Setting
568	the time with these daemons has been obsolete for over a decade.
569
57020181126:
571	On amd64, arm64 and armv7 (architectures that install LLVM's ld.lld
572	linker as /usr/bin/ld) GNU ld is no longer installed as ld.bfd, as
573	it produces broken binaries when ifuncs are in use.  Users needing
574	GNU ld should install the binutils port or package.
575
57620181123:
577	The BSD crtbegin and crtend code has been enabled by default. It has
578	had extensive testing on amd64, arm64, and i386. It can be disabled
579	by building a world with -DWITHOUT_BSD_CRTBEGIN.
580
58120181115:
582	The set of CTM commands (ctm, ctm_smail, ctm_rmail, ctm_dequeue)
583	has been converted to a port (misc/ctm) and will be removed from
584	FreeBSD-13.  It is available as a package (ctm) for all supported
585	FreeBSD versions.
586
58720181110:
588	The default newsyslog.conf(5) file has been changed to only include
589	files in /etc/newsyslog.conf.d/ and /usr/local/etc/newsyslog.conf.d/ if
590	the filenames end in '.conf' and do not begin with a '.'.
591
592	You should check the configuration files in these two directories match
593	this naming convention. You can verify which configuration files are
594	being included using the command:
595		$ newsyslog -Nrv
596
59720181015:
598	Ports for the DRM modules have been simplified. Now, amd64 users should
599	just install the drm-kmod port. All others should install
600	drm-legacy-kmod.
601
602	Graphics hardware that's newer than about 2010 usually works with
603	drm-kmod.  For hardware older than 2013, however, some users will need
604	to use drm-legacy-kmod if drm-kmod doesn't work for them. Hardware older
605	than 2008 usually only works in drm-legacy-kmod. The graphics team can
606	only commit to hardware made since 2013 due to the complexity of the
607	market and difficulty to test all the older cards effectively. If you
608	have hardware supported by drm-kmod, you are strongly encouraged to use
609	that as you will get better support.
610
611	Other than KPI chasing, drm-legacy-kmod will not be updated. As outlined
612	elsewhere, the drm and drm2 modules will be eliminated from the src base
613	soon (with a limited exception for arm). Please update to the package
614	asap and report any issues to x11@freebsd.org.
615
616	Generally, anybody using the drm*-kmod packages should add
617	WITHOUT_DRM_MODULE=t and WITHOUT_DRM2_MODULE=t to avoid nasty
618	cross-threading surprises, especially with automatic driver
619	loading from X11 startup. These will become the defaults in 13-current
620	shortly.
621
62220181012:
623	The ixlv(4) driver has been renamed to iavf(4).  As a consequence,
624	custom kernel and module loading configuration files must be updated
625	accordingly.  Moreover, interfaces previous presented as ixlvN to the
626	system are now exposed as iavfN and network configuration files must
627	be adjusted as necessary.
628
62920181009:
630	OpenSSL has been updated to version 1.1.1.  This update included
631	additional various API changes throughout the base system.  It is
632	important to rebuild third-party software after upgrading.  The value
633	of __FreeBSD_version has been bumped accordingly.
634
63520181006:
636	The legacy DRM modules and drivers have now been added to the loader's
637	module blacklist, in favor of loading them with kld_list in rc.conf(5).
638	The module blacklist may be overridden with the loader.conf(5)
639	'module_blacklist' variable, but loading them via rc.conf(5) is strongly
640	encouraged.
641
64220181002:
643	The cam(4) based nda(4) driver will be used over nvd(4) by default on
644	powerpc64. You may set 'options NVME_USE_NVD=1' in your kernel conf or
645	loader tunable 'hw.nvme.use_nvd=1' if you wish to use the existing
646	driver.  Make sure to edit /boot/etc/kboot.conf and fstab to use the
647	nda device name.
648
64920180913:
650	Reproducible build mode is now on by default, in preparation for
651	FreeBSD 12.0.  This eliminates build metadata such as the user,
652	host, and time from the kernel (and uname), unless the working tree
653	corresponds to a modified checkout from a version control system.
654	The previous behavior can be obtained by setting the /etc/src.conf
655	knob WITHOUT_REPRODUCIBLE_BUILD.
656
65720180826:
658	The Yarrow CSPRNG has been removed from the kernel as it has not been
659	supported by its designers since at least 2003. Fortuna has been the
660	default since FreeBSD-11.
661
66220180822:
663	devctl freeze/thaw have gone into the tree, the rc scripts have been
664	updated to use them and devmatch has been changed.  You should update
665	kernel, userland and rc scripts all at the same time.
666
66720180818:
668	The default interpreter has been switched from 4th to Lua.
669	LOADER_DEFAULT_INTERP, documented in build(7), will override the default
670	interpreter.  If you have custom FORTH code you will need to set
671	LOADER_DEFAULT_INTERP=4th (valid values are 4th, lua or simp) in
672	src.conf for the build.  This will create default hard links between
673	loader and loader_4th instead of loader and loader_lua, the new default.
674	If you are using UEFI it will create the proper hard link to loader.efi.
675
676	bhyve uses userboot.so. It remains 4th-only until some issues are solved
677	regarding coexisting with multiple versions of FreeBSD are resolved.
678
67920180815:
680	ls(1) now respects the COLORTERM environment variable used in other
681	systems and software to indicate that a colored terminal is both
682	supported and desired.  If ls(1) is suddenly emitting colors, they may
683	be disabled again by either removing the unwanted COLORTERM from your
684	environment, or using `ls --color=never`.  The ls(1) specific CLICOLOR
685	may not be observed in a future release.
686
68720180808:
688	The default pager for most commands has been changed to "less".  To
689	restore the old behavior, set PAGER="more" and MANPAGER="more -s" in
690	your environment.
691
69220180731:
693	The jedec_ts(4) driver has been removed. A superset of its functionality
694	is available in the jedec_dimm(4) driver, and the manpage for that
695	driver includes migration instructions. If you have "device jedec_ts"
696	in your kernel configuration file, it must be removed.
697
69820180730:
699	amd64/GENERIC now has EFI runtime services, EFIRT, enabled by default.
700	This should have no effect if the kernel is booted via BIOS/legacy boot.
701	EFIRT may be disabled via a loader tunable, efi.rt.disabled, if a system
702	has a buggy firmware that prevents a successful boot due to use of
703	runtime services.
704
70520180727:
706	Atmel AT91RM9200 and AT91SAM9, Cavium CNS 11xx and XScale
707	support has been removed from the tree. These ports were
708	obsolete and/or known to be broken for many years.
709
71020180723:
711	loader.efi has been augmented to participate more fully in the
712	UEFI boot manager protocol. loader.efi will now look at the
713	BootXXXX environment variable to determine if a specific kernel
714	or root partition was specified. XXXX is derived from BootCurrent.
715	efibootmgr(8) manages these standard UEFI variables.
716
71720180720:
718	zfsloader's functionality has now been folded into loader.
719	zfsloader is no longer necessary once you've updated your
720	boot blocks. For a transition period, we will install a
721	hardlink for zfsloader to loader to allow a smooth transition
722	until the boot blocks can be updated (hard link because old
723	zfs boot blocks don't understand symlinks).
724
72520180719:
726	ARM64 now have efifb support, if you want to have serial console
727	on your arm64 board when an screen is connected and the bootloader
728	setup a frame buffer for us to use, just add :
729	boot_serial=YES
730	boot_multicons=YES
731	in /boot/loader.conf
732	For Raspberry Pi 3 (RPI) users, this is needed even if you don't have
733	an screen connected as the firmware will setup a frame buffer are that
734	u-boot will expose as an EFI frame buffer.
735
73620180719:
737	New uid:gid added, ntpd:ntpd (123:123).  Be sure to run mergemaster
738	or take steps to update /etc/passwd before doing installworld on
739	existing systems.  Do not skip the "mergemaster -Fp" step before
740	installworld, as described in the update procedures near the bottom
741	of this document.  Also, rc.d/ntpd now starts ntpd(8) as user ntpd
742	if the new mac_ntpd(4) policy is available, unless ntpd_flags or
743	the ntp config file contain options that change file/dir locations.
744	When such options (e.g., "statsdir" or "crypto") are used, ntpd can
745	still be run as non-root by setting ntpd_user=ntpd in rc.conf, after
746	taking steps to ensure that all required files/dirs are accessible
747	by the ntpd user.
748
74920180717:
750	Big endian arm support has been removed.
751
75220180711:
753	The static environment setup in kernel configs is no longer mutually
754	exclusive with the loader(8) environment by default.  In order to
755	restore the previous default behavior of disabling the loader(8)
756	environment if a static environment is present, you must specify
757	loader_env.disabled=1 in the static environment.
758
75920180705:
760	The ABI of syscalls used by management tools like sockstat and
761	netstat has been broken to allow 32-bit binaries to work on
762	64-bit kernels without modification.  These programs will need
763	to match the kernel in order to function.  External programs may
764	require minor modifications to accommodate a change of type in
765	structures from pointers to 64-bit virtual addresses.
766
76720180702:
768	On i386 and amd64 atomics are now inlined. Out of tree modules using
769	atomics will need to be rebuilt.
770
77120180701:
772	The '%I' format in the kern.corefile sysctl limits the number of
773	core files that a process can generate to the number stored in the
774	debug.ncores sysctl. The '%I' format is replaced by the single digit
775	index. Previously, if all indexes were taken the kernel would overwrite
776	only a core file with the highest index in a filename.
777	Currently the system will create a new core file if there is a free
778	index or if all slots are taken it will overwrite the oldest one.
779
78020180630:
781	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
782	6.0.1.  Please see the 20141231 entry below for information about
783	prerequisites and upgrading, if you are not already using clang 3.5.0
784	or higher.
785
78620180628:
787	r335753 introduced a new quoting method. However, etc/devd/devmatch.conf
788	needed to be changed to work with it. This change was made with r335763
789	and requires a mergemaster / etcupdate / etc to update the installed
790	file.
791
79220180612:
793	r334930 changed the interface between the NFS modules, so they all
794	need to be rebuilt.  r335018 did a __FreeBSD_version bump for this.
795
79620180530:
797	As of r334391 lld is the default amd64 system linker; it is installed
798	as /usr/bin/ld.  Kernel build workarounds (see 20180510 entry) are no
799	longer necessary.
800
80120180530:
802	The kernel / userland interface for devinfo changed, so you'll
803	need a new kernel and userland as a pair for it to work (rebuilding
804	lib/libdevinfo is all that's required). devinfo and devmatch will
805	not work, but everything else will when there's a mismatch.
806
80720180523:
808	The on-disk format for hwpmc callchain records has changed to include
809	threadid corresponding to a given record. This changes the field offsets
810	and thus requires that libpmcstat be rebuilt before using a kernel
811	later than r334108.
812
81320180517:
814	The vxge(4) driver has been removed.  This driver was introduced into
815	HEAD one week before the Exar left the Ethernet market and is not
816	known to be used.  If you have device vxge in your kernel config file
817	it must be removed.
818
81920180510:
820	The amd64 kernel now requires a ld that supports ifunc to produce a
821	working kernel, either lld or a newer binutils. lld is built by default
822	on amd64, and the 'buildkernel' target uses it automatically. However,
823	it is not the default linker, so building the kernel the traditional
824	way requires LD=ld.lld on the command line (or LD=/usr/local/bin/ld for
825	binutils port/package). lld will soon be default, and this requirement
826	will go away.
827
828	NOTE: As of r334391 lld is the default system linker on amd64, and no
829	workaround is necessary.
830
83120180508:
832	The nxge(4) driver has been removed.  This driver was for PCI-X 10g
833	cards made by s2io/Neterion.  The company was acquired by Exar and
834	no longer sells or supports Ethernet products.  If you have device
835	nxge in your kernel config file it must be removed.
836
83720180504:
838	The tz database (tzdb) has been updated to 2018e.  This version more
839	correctly models time stamps in time zones with negative DST such as
840	Europe/Dublin (from 1971 on), Europe/Prague (1946/7), and
841	Africa/Windhoek (1994/2017).  This does not affect the UT offsets, only
842	time zone abbreviations and the tm_isdst flag.
843
84420180502:
845	The ixgb(4) driver has been removed.  This driver was for an early and
846	uncommon legacy PCI 10GbE for a single ASIC, Intel 82597EX. Intel
847	quickly shifted to the long lived ixgbe family.  If you have device
848	ixgb in your kernel config file it must be removed.
849
85020180501:
851	The lmc(4) driver has been removed.  This was a WAN interface
852	card that was already reportedly rare in 2003, and had an ambiguous
853	license.  If you have device lmc in your kernel config file it must
854	be removed.
855
85620180413:
857	Support for Arcnet networks has been removed.  If you have device
858	arcnet or device cm in your kernel config file they must be
859	removed.
860
86120180411:
862	Support for FDDI networks has been removed.  If you have device
863	fddi or device fpa in your kernel config file they must be
864	removed.
865
86620180406:
867	In addition to supporting RFC 3164 formatted messages, the
868	syslogd(8) service is now capable of parsing RFC 5424 formatted
869	log messages. The main benefit of using RFC 5424 is that clients
870	may now send log messages with timestamps containing year numbers,
871	microseconds and time zone offsets.
872
873	Similarly, the syslog(3) C library function has been altered to
874	send RFC 5424 formatted messages to the local system logging
875	daemon. On systems using syslogd(8), this change should have no
876	negative impact, as long as syslogd(8) and the C library are
877	updated at the same time. On systems using a different system
878	logging daemon, it may be necessary to make configuration
879	adjustments, depending on the software used.
880
881	When using syslog-ng, add the 'syslog-protocol' flag to local
882	input sources to enable parsing of RFC 5424 formatted messages:
883
884		source src {
885			unix-dgram("/var/run/log" flags(syslog-protocol));
886		}
887
888	When using rsyslog, disable the 'SysSock.UseSpecialParser' option
889	of the 'imuxsock' module to let messages be processed by the
890	regular RFC 3164/5424 parsing pipeline:
891
892		module(load="imuxsock" SysSock.UseSpecialParser="off")
893
894	Do note that these changes only affect communication between local
895	applications and syslogd(8). The format that syslogd(8) uses to
896	store messages on disk or forward messages to other systems
897	remains unchanged. syslogd(8) still uses RFC 3164 for these
898	purposes. Options to customize this behaviour will be added in the
899	future. Utilities that process log files stored in /var/log are
900	thus expected to continue to function as before.
901
902	__FreeBSD_version has been incremented to 1200061 to denote this
903	change.
904
90520180328:
906	Support for token ring networks has been removed. If you
907	have "device token" in your kernel config you should remove
908	it. No device drivers supported token ring.
909
91020180323:
911	makefs was modified to be able to tag ISO9660 El Torito boot catalog
912	entries as EFI instead of overloading the i386 tag as done previously.
913	The amd64 mkisoimages.sh script used to build amd64 ISO images for
914	release was updated to use this. This may mean that makefs must be
915	updated before "make cdrom" can be run in the release directory. This
916	should be as simple as:
917
918		$ cd $SRCDIR/usr.sbin/makefs
919		$ make depend all install
920
92120180212:
922	FreeBSD boot loader enhanced with Lua scripting. It's purely opt-in for
923	now by building WITH_LOADER_LUA and WITHOUT_FORTH in /etc/src.conf.
924	Co-existence for the transition period will come shortly. Booting is a
925	complex environment and test coverage for Lua-enabled loaders has been
926	thin, so it would be prudent to assume it might not work and make
927	provisions for backup boot methods.
928
92920180211:
930	devmatch functionality has been turned on in devd. It will automatically
931	load drivers for unattached devices. This may cause unexpected drivers
932	to be loaded. Please report any problems to current@ and
933	imp@freebsd.org.
934
93520180114:
936	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
937	6.0.0.  Please see the 20141231 entry below for information about
938	prerequisites and upgrading, if you are not already using clang 3.5.0
939	or higher.
940
94120180110:
942	LLVM's lld linker is now used as the FreeBSD/amd64 bootstrap linker.
943	This means it is used to link the kernel and userland libraries and
944	executables, but is not yet installed as /usr/bin/ld by default.
945
946	To revert to ld.bfd as the bootstrap linker, in /etc/src.conf set
947	WITHOUT_LLD_BOOTSTRAP=yes
948
94920180110:
950	On i386, pmtimer has been removed. Its functionality has been folded
951	into apm. It was a no-op on ACPI in current for a while now (but was
952	still needed on i386 in FreeBSD 11 and earlier). Users may need to
953	remove it from kernel config files.
954
95520180104:
956	The use of RSS hash from the network card aka flowid has been
957	disabled by default for lagg(4) as it's currently incompatible with
958	the lacp and loadbalance protocols.
959
960	This can be re-enabled by setting the following in loader.conf:
961	net.link.lagg.default_use_flowid="1"
962
96320180102:
964	The SW_WATCHDOG option is no longer necessary to enable the
965	hardclock-based software watchdog if no hardware watchdog is
966	configured. As before, SW_WATCHDOG will cause the software
967	watchdog to be enabled even if a hardware watchdog is configured.
968
96920171215:
970	r326887 fixes the issue described in the 20171214 UPDATING entry.
971	r326888 flips the switch back to building GELI support always.
972
97320171214:
974	r362593 broke ZFS + GELI support for reasons unknown. However,
975	it also broke ZFS support generally, so GELI has been turned off
976	by default as the lesser evil in r326857. If you boot off ZFS and/or
977	GELI, it might not be a good time to update.
978
97920171125:
980	PowerPC users must update loader(8) by rebuilding world before
981	installing a new kernel, as the protocol connecting them has
982	changed. Without the update, loader metadata will not be passed
983	successfully to the kernel and users will have to enter their
984	root partition at the kernel mountroot prompt to continue booting.
985	Newer versions of loader can boot old kernels without issue.
986
98720171110:
988	The LOADER_FIREWIRE_SUPPORT build variable as been renamed to
989	WITH/OUT_LOADER_FIREWIRE. LOADER_{NO_,}GELI_SUPPORT has been renamed
990	to WITH/OUT_LOADER_GELI.
991
99220171106:
993	The naive and non-compliant support of posix_fallocate(2) in ZFS
994	has been removed as of r325320.  The system call now returns EINVAL
995	when used on a ZFS file.  Although the new behavior complies with the
996	standard, some consumers are not prepared to cope with it.
997	One known victim is lld prior to r325420.
998
99920171102:
1000	Building in a FreeBSD src checkout will automatically create object
1001	directories now rather than store files in the current directory if
1002	'make obj' was not ran.  Calling 'make obj' is no longer necessary.
1003	This feature can be disabled by setting WITHOUT_AUTO_OBJ=yes in
1004	/etc/src-env.conf (not /etc/src.conf), or passing the option in the
1005	environment.
1006
100720171101:
1008	The default MAKEOBJDIR has changed from /usr/obj/<srcdir> for native
1009	builds, and /usr/obj/<arch>/<srcdir> for cross-builds, to a unified
1010	/usr/obj/<srcdir>/<arch>.  This behavior can be changed to the old
1011	format by setting WITHOUT_UNIFIED_OBJDIR=yes in /etc/src-env.conf,
1012	the environment, or with -DWITHOUT_UNIFIED_OBJDIR when building.
1013	The UNIFIED_OBJDIR option is a transitional feature that will be
1014	removed for 12.0 release; please migrate to the new format for any
1015	tools by looking up the OBJDIR used by 'make -V .OBJDIR' means rather
1016	than hardcoding paths.
1017
101820171028:
1019	The native-xtools target no longer installs the files by default to the
1020	OBJDIR.  Use the native-xtools-install target with a DESTDIR to install
1021	to ${DESTDIR}/${NXTP} where NXTP defaults to /nxb-bin.
1022
102320171021:
1024	As part of the boot loader infrastructure cleanup, LOADER_*_SUPPORT
1025	options are changing from controlling the build if defined / undefined
1026	to controlling the build with explicit 'yes' or 'no' values. They will
1027	shift to WITH/WITHOUT options to match other options in the system.
1028
102920171010:
1030	libstand has turned into a private library for sys/boot use only.
1031	It is no longer supported as a public interface outside of sys/boot.
1032
103320171005:
1034	The arm port has split armv6 into armv6 and armv7. armv7 is now
1035	a valid TARGET_ARCH/MACHINE_ARCH setting. If you have an armv7 system
1036	and are running a kernel from before r324363, you will need to add
1037	MACHINE_ARCH=armv7 to 'make buildworld' to do a native build.
1038
103920171003:
1040	When building multiple kernels using KERNCONF, non-existent KERNCONF
1041	files will produce an error and buildkernel will fail. Previously
1042	missing KERNCONF files silently failed giving no indication as to
1043	why, only to subsequently discover during installkernel that the
1044	desired kernel was never built in the first place.
1045
104620170912:
1047	The default serial number format for CTL LUNs has changed.  This will
1048	affect users who use /dev/diskid/* device nodes, or whose FibreChannel
1049	or iSCSI clients care about their LUNs' serial numbers.  Users who
1050	require serial number stability should hardcode serial numbers in
1051	/etc/ctl.conf .
1052
105320170912:
1054	For 32-bit arm compiled for hard-float support, soft-floating point
1055	binaries now always get their shared libraries from
1056	LD_SOFT_LIBRARY_PATH (in the past, this was only used if
1057	/usr/libsoft also existed). Only users with a hard-float ld.so, but
1058	soft-float everything else should be affected.
1059
106020170826:
1061	The geli password typed at boot is now hidden.  To restore the previous
1062	behavior, see geli(8) for configuration options.
1063
106420170825:
1065	Move PMTUD blackhole counters to TCPSTATS and remove them from bare
1066	sysctl values.  Minor nit, but requires a rebuild of both world/kernel
1067	to complete.
1068
106920170814:
1070	"make check" behavior (made in ^/head@r295380) has been changed to
1071	execute from a limited sandbox, as opposed to executing from
1072	${TESTSDIR}.
1073
1074	Behavioral changes:
1075	- The "beforecheck" and "aftercheck" targets are now specified.
1076	- ${CHECKDIR} (added in commit noted above) has been removed.
1077	- Legacy behavior can be enabled by setting
1078	  WITHOUT_MAKE_CHECK_USE_SANDBOX in src.conf(5) or the environment.
1079
1080	If the limited sandbox mode is enabled, "make check" will execute
1081	"make distribution", then install, execute the tests, and clean up the
1082	sandbox if successful.
1083
1084	The "make distribution" and "make install" targets are typically run as
1085	root to set appropriate permissions and ownership at installation time.
1086	The end-user should set "WITH_INSTALL_AS_USER" in src.conf(5) or the
1087	environment if executing "make check" with limited sandbox mode using
1088	an unprivileged user.
1089
109020170808:
1091	Since the switch to GPT disk labels, fsck for UFS/FFS has been
1092	unable to automatically find alternate superblocks. As of r322297,
1093	the information needed to find alternate superblocks has been
1094	moved to the end of the area reserved for the boot block.
1095	Filesystems created with a newfs of this vintage or later
1096	will create the recovery information. If you have a filesystem
1097	created prior to this change and wish to have a recovery block
1098	created for your filesystem, you can do so by running fsck in
1099	foreground mode (i.e., do not use the -p or -y options). As it
1100	starts, fsck will ask ``SAVE DATA TO FIND ALTERNATE SUPERBLOCKS''
1101	to which you should answer yes.
1102
110320170728:
1104	As of r321665, an NFSv4 server configuration that services
1105	Kerberos mounts or clients that do not support the uid/gid in
1106	owner/owner_group string capability, must explicitly enable
1107	the nfsuserd daemon by adding nfsuserd_enable="YES" to the
1108	machine's /etc/rc.conf file.
1109
111020170722:
1111	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 5.0.0.
1112	Please see the 20141231 entry below for information about prerequisites
1113	and upgrading, if you are not already using clang 3.5.0 or higher.
1114
111520170701:
1116	WITHOUT_RCMDS is now the default. Set WITH_RCMDS if you need the
1117	r-commands (rlogin, rsh, etc.) to be built with the base system.
1118
111920170625:
1120	The FreeBSD/powerpc platform now uses a 64-bit type for time_t.  This is
1121	a very major ABI incompatible change, so users of FreeBSD/powerpc must
1122	be careful when performing source upgrades.  It is best to run
1123	'make installworld' from an alternate root system, either a live
1124	CD/memory stick, or a temporary root partition.  Additionally, all ports
1125	must be recompiled.  powerpc64 is largely unaffected, except in the case
1126	of 32-bit compatibility.  All 32-bit binaries will be affected.
1127
112820170623:
1129	Forward compatibility for the "ino64" project have been committed. This
1130	will allow most new binaries to run on older kernels in a limited
1131	fashion.  This prevents many of the common foot-shooting actions in the
1132	upgrade as well as the limited ability to roll back the kernel across
1133	the ino64 upgrade. Complicated use cases may not work properly, though
1134	enough simpler ones work to allow recovery in most situations.
1135
113620170620:
1137	Switch back to the BSDL dtc (Device Tree Compiler). Set WITH_GPL_DTC
1138	if you require the GPL compiler.
1139
114020170618:
1141	The internal ABI used for communication between the NFS kernel modules
1142	was changed by r320085, so __FreeBSD_version was bumped to
1143	ensure all the NFS related modules are updated together.
1144
114520170617:
1146	The ABI of struct event was changed by extending the data
1147	member to 64bit and adding ext fields.  For upgrade, same
1148	precautions as for the entry 20170523 "ino64" must be
1149	followed.
1150
115120170531:
1152	The GNU roff toolchain has been removed from base. To render manpages
1153	which are not supported by mandoc(1), man(1) can fallback on GNU roff
1154	from ports (and recommends to install it).
1155	To render roff(7) documents, consider using GNU roff from ports or the
1156	heirloom doctools roff toolchain from ports via pkg install groff or
1157	via pkg install heirloom-doctools.
1158
115920170524:
1160	The ath(4) and ath_hal(4) modules now build piecemeal to allow for
1161	smaller runtime footprint builds.  This is useful for embedded systems
1162	which only require one chipset support.
1163
1164	If you load it as a module, make sure this is in /boot/loader.conf:
1165
1166	if_ath_load="YES"
1167
1168	This will load the HAL, all chip/RF backends and if_ath_pci.
1169	If you have if_ath_pci in /boot/loader.conf, ensure it is after
1170	if_ath or it will not load any HAL chipset support.
1171
1172	If you want to selectively load things (eg on ye cheape ARM/MIPS
1173	platforms where RAM is at a premium) you should:
1174
1175	* load ath_hal
1176	* load the chip modules in question
1177	* load ath_rate, ath_dfs
1178	* load ath_main
1179	* load if_ath_pci and/or if_ath_ahb depending upon your particular
1180	  bus bind type - this is where probe/attach is done.
1181
1182	For further comments/feedback, poke adrian@ .
1183
118420170523:
1185	The "ino64" 64-bit inode project has been committed, which extends
1186	a number of types to 64 bits.  Upgrading in place requires care and
1187	adherence to the documented upgrade procedure.
1188
1189	If using a custom kernel configuration ensure that the
1190	COMPAT_FREEBSD11 option is included (as during the upgrade the
1191	system will be running the ino64 kernel with the existing world).
1192
1193	For the safest in-place upgrade begin by removing previous build
1194	artifacts via "rm -rf /usr/obj/*".  Then, carefully follow the full
1195	procedure documented below under the heading "To rebuild everything and
1196	install it on the current system."  Specifically, a reboot is required
1197	after installing the new kernel before installing world. While an
1198	installworld normally works by accident from multiuser after rebooting
1199	the proper kernel, there are many cases where this will fail across this
1200	upgrade and installworld from single user is required.
1201
120220170424:
1203	The NATM framework including the en(4), fatm(4), hatm(4), and
1204	patm(4) devices has been removed.  Consumers should plan a
1205	migration before the end-of-life date for FreeBSD 11.
1206
120720170420:
1208	GNU diff has been replaced by a BSD licensed diff. Some features of GNU
1209	diff has not been implemented, if those are needed a newer version of
1210	GNU diff is available via the diffutils package under the gdiff name.
1211
121220170413:
1213	As of r316810 for ipfilter, keep frags is no longer assumed when
1214	keep state is specified in a rule. r316810 aligns ipfilter with
1215	documentation in man pages separating keep frags from keep state.
1216	This allows keep state to be specified without forcing keep frags
1217	and allows keep frags to be specified independently of keep state.
1218	To maintain previous behaviour, also specify keep frags with
1219	keep state (as documented in ipf.conf.5).
1220
122120170407:
1222	arm64 builds now use the base system LLD 4.0.0 linker by default,
1223	instead of requiring that the aarch64-binutils port or package be
1224	installed. To continue using aarch64-binutils, set
1225	CROSS_BINUTILS_PREFIX=/usr/local/aarch64-freebsd/bin .
1226
122720170405:
1228	The UDP optimization in entry 20160818 that added the sysctl
1229	net.inet.udp.require_l2_bcast has been reverted.  L2 broadcast
1230	packets will no longer be treated as L3 broadcast packets.
1231
123220170331:
1233	Binds and sends to the loopback addresses, IPv6 and IPv4, will now
1234	use any explicitly assigned loopback address available in the jail
1235	instead of using the first assigned address of the jail.
1236
123720170329:
1238	The ctl.ko module no longer implements the iSCSI target frontend:
1239	cfiscsi.ko does instead.
1240
1241	If building cfiscsi.ko as a kernel module, the module can be loaded
1242	via one of the following methods:
1243	- `cfiscsi_load="YES"` in loader.conf(5).
1244	- Add `cfiscsi` to `$kld_list` in rc.conf(5).
1245	- ctladm(8)/ctld(8), when compiled with iSCSI support
1246	  (`WITH_ISCSI=yes` in src.conf(5))
1247
1248	Please see cfiscsi(4) for more details.
1249
125020170316:
1251	The mmcsd.ko module now additionally depends on geom_flashmap.ko.
1252	Also, mmc.ko and mmcsd.ko need to be a matching pair built from the
1253	same source (previously, the dependency of mmcsd.ko on mmc.ko was
1254	missing, but mmcsd.ko now will refuse to load if it is incompatible
1255	with mmc.ko).
1256
125720170315:
1258	The syntax of ipfw(8) named states was changed to avoid ambiguity.
1259	If you have used named states in the firewall rules, you need to modify
1260	them after installworld and before rebooting. Now named states must
1261	be prefixed with colon.
1262
126320170311:
1264	The old drm (sys/dev/drm/) drivers for i915 and radeon have been
1265	removed as the userland we provide cannot use them. The KMS version
1266	(sys/dev/drm2) supports the same hardware.
1267
126820170302:
1269	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 4.0.0.
1270	Please see the 20141231 entry below for information about prerequisites
1271	and upgrading, if you are not already using clang 3.5.0 or higher.
1272
127320170221:
1274	The code that provides support for ZFS .zfs/ directory functionality
1275	has been reimplemented.  It's not possible now to create a snapshot
1276	by mkdir under .zfs/snapshot/.  That should be the only user visible
1277	change.
1278
127920170216:
1280	EISA bus support has been removed. The WITH_EISA option is no longer
1281	valid.
1282
128320170215:
1284	MCA bus support has been removed.
1285
128620170127:
1287	The WITH_LLD_AS_LD / WITHOUT_LLD_AS_LD build knobs have been renamed
1288	WITH_LLD_IS_LD / WITHOUT_LLD_IS_LD, for consistency with CLANG_IS_CC.
1289
129020170112:
1291	The EM_MULTIQUEUE kernel configuration option is deprecated now that
1292	the em(4) driver conforms to iflib specifications.
1293
129420170109:
1295	The igb(4), em(4) and lem(4) ethernet drivers are now implemented via
1296	IFLIB.  If you have a custom kernel configuration that excludes em(4)
1297	but you use igb(4), you need to re-add em(4) to your custom
1298	configuration.
1299
130020161217:
1301	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.1.
1302	Please see the 20141231 entry below for information about prerequisites
1303	and upgrading, if you are not already using clang 3.5.0 or higher.
1304
130520161124:
1306	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.0.
1307	Please see the 20141231 entry below for information about prerequisites
1308	and upgrading, if you are not already using clang 3.5.0 or higher.
1309
131020161119:
1311	The layout of the pmap structure has changed for powerpc to put the pmap
1312	statistics at the front for all CPU variations.  libkvm(3) and all tools
1313	that link against it need to be recompiled.
1314
131520161030:
1316	isl(4) and cyapa(4) drivers now require a new driver,
1317	chromebook_platform(4), to work properly on Chromebook-class hardware.
1318	On other types of hardware the drivers may need to be configured using
1319	device hints.  Please see the corresponding manual pages for details.
1320
132120161017:
1322	The urtwn(4) driver was merged into rtwn(4) and now consists of
1323	rtwn(4) main module + rtwn_usb(4) and rtwn_pci(4) bus-specific
1324	parts.
1325	Also, firmware for RTL8188CE was renamed due to possible name
1326	conflict (rtwnrtl8192cU(B) -> rtwnrtl8192cE(B))
1327
132820161015:
1329	GNU rcs has been removed from base.  It is available as packages:
1330	- rcs: Latest GPLv3 GNU rcs version.
1331	- rcs57: Copy of the latest version of GNU rcs (GPLv2) before it was
1332	removed from base.
1333
133420161008:
1335	Use of the cc_cdg, cc_chd, cc_hd, or cc_vegas congestion control
1336	modules now requires that the kernel configuration contain the
1337	TCP_HHOOK option. (This option is included in the GENERIC kernel.)
1338
133920161003:
1340	The WITHOUT_ELFCOPY_AS_OBJCOPY src.conf(5) knob has been retired.
1341	ELF Tool Chain's elfcopy is always installed as /usr/bin/objcopy.
1342
134320160924:
1344	Relocatable object files with the extension of .So have been renamed
1345	to use an extension of .pico instead.  The purpose of this change is
1346	to avoid a name clash with shared libraries on case-insensitive file
1347	systems.  On those file systems, foo.So is the same file as foo.so.
1348
134920160918:
1350	GNU rcs has been turned off by default.  It can (temporarily) be built
1351	again by adding WITH_RCS knob in src.conf.
1352	Otherwise, GNU rcs is available from packages:
1353	- rcs: Latest GPLv3 GNU rcs version.
1354	- rcs57: Copy of the latest version of GNU rcs (GPLv2) from base.
1355
135620160918:
1357	The backup_uses_rcs functionality has been removed from rc.subr.
1358
135920160908:
1360	The queue(3) debugging macro, QUEUE_MACRO_DEBUG, has been split into
1361	two separate components, QUEUE_MACRO_DEBUG_TRACE and
1362	QUEUE_MACRO_DEBUG_TRASH.  Define both for the original
1363	QUEUE_MACRO_DEBUG behavior.
1364
136520160824:
1366	r304787 changed some ioctl interfaces between the iSCSI userspace
1367	programs and the kernel.  ctladm, ctld, iscsictl, and iscsid must be
1368	rebuilt to work with new kernels.  __FreeBSD_version has been bumped
1369	to 1200005.
1370
137120160818:
1372	The UDP receive code has been updated to only treat incoming UDP
1373	packets that were addressed to an L2 broadcast address as L3
1374	broadcast packets.  It is not expected that this will affect any
1375	standards-conforming UDP application.  The new behaviour can be
1376	disabled by setting the sysctl net.inet.udp.require_l2_bcast to
1377	0.
1378
137920160818:
1380	Remove the openbsd_poll system call.
1381	__FreeBSD_version has been bumped because of this.
1382
138320160708:
1384	The stable/11 branch has been created from head@r302406.
1385
138620160622:
1387	The libc stub for the pipe(2) system call has been replaced with
1388	a wrapper that calls the pipe2(2) system call and the pipe(2)
1389	system call is now only implemented by the kernels that include
1390	"options COMPAT_FREEBSD10" in their config file (this is the
1391	default).  Users should ensure that this option is enabled in
1392	their kernel or upgrade userspace to r302092 before upgrading their
1393	kernel.
1394
139520160527:
1396	CAM will now strip leading spaces from SCSI disks' serial numbers.
1397	This will affect users who create UFS filesystems on SCSI disks using
1398	those disk's diskid device nodes.  For example, if /etc/fstab
1399	previously contained a line like
1400	"/dev/diskid/DISK-%20%20%20%20%20%20%20ABCDEFG0123456", you should
1401	change it to "/dev/diskid/DISK-ABCDEFG0123456".  Users of geom
1402	transforms like gmirror may also be affected.  ZFS users should
1403	generally be fine.
1404
140520160523:
1406	The bitstring(3) API has been updated with new functionality and
1407	improved performance.  But it is binary-incompatible with the old API.
1408	Objects built with the new headers may not be linked against objects
1409	built with the old headers.
1410
141120160520:
1412	The brk and sbrk functions have been removed from libc on arm64.
1413	Binutils from ports has been updated to not link to these
1414	functions and should be updated to the latest version before
1415	installing a new libc.
1416
141720160517:
1418	The armv6 port now defaults to hard float ABI. Limited support
1419	for running both hardfloat and soft float on the same system
1420	is available using the libraries installed with -DWITH_LIBSOFT.
1421	This has only been tested as an upgrade path for installworld
1422	and packages may fail or need manual intervention to run. New
1423	packages will be needed.
1424
1425	To update an existing self-hosted armv6hf system, you must add
1426	TARGET_ARCH=armv6 on the make command line for both the build
1427	and the install steps.
1428
142920160510:
1430	Kernel modules compiled outside of a kernel build now default to
1431	installing to /boot/modules instead of /boot/kernel.  Many kernel
1432	modules built this way (such as those in ports) already overrode
1433	KMODDIR explicitly to install into /boot/modules.  However,
1434	manually building and installing a module from /sys/modules will
1435	now install to /boot/modules instead of /boot/kernel.
1436
143720160414:
1438	The CAM I/O scheduler has been committed to the kernel. There should be
1439	no user visible impact. This does enable NCQ Trim on ada SSDs. While the
1440	list of known rogues that claim support for this but actually corrupt
1441	data is believed to be complete, be on the lookout for data
1442	corruption. The known rogue list is believed to be complete:
1443
1444		o Crucial MX100, M550 drives with MU01 firmware.
1445		o Micron M510 and M550 drives with MU01 firmware.
1446		o Micron M500 prior to MU07 firmware
1447		o Samsung 830, 840, and 850 all firmwares
1448		o FCCT M500 all firmwares
1449
1450	Crucial has firmware http://www.crucial.com/usa/en/support-ssd-firmware
1451	with working NCQ TRIM. For Micron branded drives, see your sales rep for
1452	updated firmware. Black listed drives will work correctly because these
1453	drives work correctly so long as no NCQ TRIMs are sent to them. Given
1454	this list is the same as found in Linux, it's believed there are no
1455	other rogues in the market place. All other models from the above
1456	vendors work.
1457
1458	To be safe, if you are at all concerned, you can quirk each of your
1459	drives to prevent NCQ from being sent by setting:
1460		kern.cam.ada.X.quirks="0x2"
1461	in loader.conf. If the drive requires the 4k sector quirk, set the
1462	quirks entry to 0x3.
1463
146420160330:
1465	The FAST_DEPEND build option has been removed and its functionality is
1466	now the one true way.  The old mkdep(1) style of 'make depend' has
1467	been removed.  See 20160311 for further details.
1468
146920160317:
1470	Resource range types have grown from unsigned long to uintmax_t.  All
1471	drivers, and anything using libdevinfo, need to be recompiled.
1472
147320160311:
1474	WITH_FAST_DEPEND is now enabled by default for in-tree and out-of-tree
1475	builds.  It no longer runs mkdep(1) during 'make depend', and the
1476	'make depend' stage can safely be skipped now as it is auto ran
1477	when building 'make all' and will generate all SRCS and DPSRCS before
1478	building anything else.  Dependencies are gathered at compile time with
1479	-MF flags kept in separate .depend files per object file.  Users should
1480	run 'make cleandepend' once if using -DNO_CLEAN to clean out older
1481	stale .depend files.
1482
148320160306:
1484	On amd64, clang 3.8.0 can now insert sections of type AMD64_UNWIND into
1485	kernel modules.  Therefore, if you load any kernel modules at boot time,
1486	please install the boot loaders after you install the kernel, but before
1487	rebooting, e.g.:
1488
1489	make buildworld
1490	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1491	make installkernel KERNCONF=YOUR_KERNEL_HERE
1492	make -C sys/boot install
1493	<reboot in single user>
1494
1495	Then follow the usual steps, described in the General Notes section,
1496	below.
1497
149820160305:
1499	Clang, llvm, lldb and compiler-rt have been upgraded to 3.8.0.  Please
1500	see the 20141231 entry below for information about prerequisites and
1501	upgrading, if you are not already using clang 3.5.0 or higher.
1502
150320160301:
1504	The AIO subsystem is now a standard part of the kernel.  The
1505	VFS_AIO kernel option and aio.ko kernel module have been removed.
1506	Due to stability concerns, asynchronous I/O requests are only
1507	permitted on sockets and raw disks by default.  To enable
1508	asynchronous I/O requests on all file types, set the
1509	vfs.aio.enable_unsafe sysctl to a non-zero value.
1510
151120160226:
1512	The ELF object manipulation tool objcopy is now provided by the
1513	ELF Tool Chain project rather than by GNU binutils. It should be a
1514	drop-in replacement, with the addition of arm64 support. The
1515	(temporary) src.conf knob WITHOUT_ELFCOPY_AS_OBJCOPY knob may be set
1516	to obtain the GNU version if necessary.
1517
151820160129:
1519	Building ZFS pools on top of zvols is prohibited by default.  That
1520	feature has never worked safely; it's always been prone to deadlocks.
1521	Using a zvol as the backing store for a VM guest's virtual disk will
1522	still work, even if the guest is using ZFS.  Legacy behavior can be
1523	restored by setting vfs.zfs.vol.recursive=1.
1524
152520160119:
1526	The NONE and HPN patches has been removed from OpenSSH.  They are
1527	still available in the security/openssh-portable port.
1528
152920160113:
1530	With the addition of ypldap(8), a new _ypldap user is now required
1531	during installworld. "mergemaster -p" can be used to add the user
1532	prior to installworld, as documented in the handbook.
1533
153420151216:
1535	The tftp loader (pxeboot) now uses the option root-path directive. As a
1536	consequence it no longer looks for a pxeboot.4th file on the tftp
1537	server. Instead it uses the regular /boot infrastructure as with the
1538	other loaders.
1539
154020151211:
1541	The code to start recording plug and play data into the modules has
1542	been committed. While the old tools will properly build a new kernel,
1543	a number of warnings about "unknown metadata record 4" will be produced
1544	for an older kldxref. To avoid such warnings, make sure to rebuild
1545	the kernel toolchain (or world). Make sure that you have r292078 or
1546	later when trying to build 292077 or later before rebuilding.
1547
154820151207:
1549	Debug data files are now built by default with 'make buildworld' and
1550	installed with 'make installworld'. This facilitates debugging but
1551	requires more disk space both during the build and for the installed
1552	world. Debug files may be disabled by setting WITHOUT_DEBUG_FILES=yes
1553	in src.conf(5).
1554
155520151130:
1556	r291527 changed the internal interface between the nfsd.ko and
1557	nfscommon.ko modules. As such, they must both be upgraded to-gether.
1558	__FreeBSD_version has been bumped because of this.
1559
156020151108:
1561	Add support for unicode collation strings leads to a change of
1562	order of files listed by ls(1) for example. To get back to the old
1563	behaviour, set LC_COLLATE environment variable to "C".
1564
1565	Databases administrators will need to reindex their databases given
1566	collation results will be different.
1567
1568	Due to a bug in install(1) it is recommended to remove the ancient
1569	locales before running make installworld.
1570
1571	rm -rf /usr/share/locale/*
1572
157320151030:
1574	The OpenSSL has been upgraded to 1.0.2d.  Any binaries requiring
1575	libcrypto.so.7 or libssl.so.7 must be recompiled.
1576
157720151020:
1578	Qlogic 24xx/25xx firmware images were updated from 5.5.0 to 7.3.0.
1579	Kernel modules isp_2400_multi and isp_2500_multi were removed and
1580	should be replaced with isp_2400 and isp_2500 modules respectively.
1581
158220151017:
1583	The build previously allowed using 'make -n' to not recurse into
1584	sub-directories while showing what commands would be executed, and
1585	'make -n -n' to recursively show commands.  Now 'make -n' will recurse
1586	and 'make -N' will not.
1587
158820151012:
1589	If you specify SENDMAIL_MC or SENDMAIL_CF in make.conf, mergemaster
1590	and etcupdate will now use this file. A custom sendmail.cf is now
1591	updated via this mechanism rather than via installworld.  If you had
1592	excluded sendmail.cf in mergemaster.rc or etcupdate.conf, you may
1593	want to remove the exclusion or change it to "always install".
1594	/etc/mail/sendmail.cf is now managed the same way regardless of
1595	whether SENDMAIL_MC/SENDMAIL_CF is used.  If you are not using
1596	SENDMAIL_MC/SENDMAIL_CF there should be no change in behavior.
1597
159820151011:
1599	Compatibility shims for legacy ATA device names have been removed.
1600	It includes ATA_STATIC_ID kernel option, kern.cam.ada.legacy_aliases
1601	and kern.geom.raid.legacy_aliases loader tunables, kern.devalias.*
1602	environment variables, /dev/ad* and /dev/ar* symbolic links.
1603
160420151006:
1605	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.7.0.
1606	Please see the 20141231 entry below for information about prerequisites
1607	and upgrading, if you are not already using clang 3.5.0 or higher.
1608
160920150924:
1610	Kernel debug files have been moved to /usr/lib/debug/boot/kernel/,
1611	and renamed from .symbols to .debug. This reduces the size requirements
1612	on the boot partition or file system and provides consistency with
1613	userland debug files.
1614
1615	When using the supported kernel installation method the
1616	/usr/lib/debug/boot/kernel directory will be renamed (to kernel.old)
1617	as is done with /boot/kernel.
1618
1619	Developers wishing to maintain the historical behavior of installing
1620	debug files in /boot/kernel/ can set KERN_DEBUGDIR="" in src.conf(5).
1621
162220150827:
1623	The wireless drivers had undergone changes that remove the 'parent
1624	interface' from the ifconfig -l output. The rc.d network scripts
1625	used to check presence of a parent interface in the list, so old
1626	scripts would fail to start wireless networking. Thus, etcupdate(3)
1627	or mergemaster(8) run is required after kernel update, to update your
1628	rc.d scripts in /etc.
1629
163020150827:
1631	pf no longer supports 'scrub fragment crop' or 'scrub fragment drop-ovl'
1632	These configurations are now automatically interpreted as
1633	'scrub fragment reassemble'.
1634
163520150817:
1636	Kernel-loadable modules for the random(4) device are back. To use
1637	them, the kernel must have
1638
1639	device	random
1640	options	RANDOM_LOADABLE
1641
1642	kldload(8) can then be used to load random_fortuna.ko
1643	or random_yarrow.ko. Please note that due to the indirect
1644	function calls that the loadable modules need to provide,
1645	the build-in variants will be slightly more efficient.
1646
1647	The random(4) kernel option RANDOM_DUMMY has been retired due to
1648	unpopularity. It was not all that useful anyway.
1649
165020150813:
1651	The WITHOUT_ELFTOOLCHAIN_TOOLS src.conf(5) knob has been retired.
1652	Control over building the ELF Tool Chain tools is now provided by
1653	the WITHOUT_TOOLCHAIN knob.
1654
165520150810:
1656	The polarity of Pulse Per Second (PPS) capture events with the
1657	uart(4) driver has been corrected.  Prior to this change the PPS
1658	"assert" event corresponded to the trailing edge of a positive PPS
1659	pulse and the "clear" event was the leading edge of the next pulse.
1660
1661	As the width of a PPS pulse in a typical GPS receiver is on the
1662	order of 1 millisecond, most users will not notice any significant
1663	difference with this change.
1664
1665	Anyone who has compensated for the historical polarity reversal by
1666	configuring a negative offset equal to the pulse width will need to
1667	remove that workaround.
1668
166920150809:
1670	The default group assigned to /dev/dri entries has been changed
1671	from 'wheel' to 'video' with the id of '44'. If you want to have
1672	access to the dri devices please add yourself to the video group
1673	with:
1674
1675	# pw groupmod video -m $USER
1676
167720150806:
1678	The menu.rc and loader.rc files will now be replaced during
1679	upgrades. Please migrate local changes to menu.rc.local and
1680	loader.rc.local instead.
1681
168220150805:
1683	GNU Binutils versions of addr2line, c++filt, nm, readelf, size,
1684	strings and strip have been removed. The src.conf(5) knob
1685	WITHOUT_ELFTOOLCHAIN_TOOLS no longer provides the binutils tools.
1686
168720150728:
1688	As ZFS requires more kernel stack pages than is the default on some
1689	architectures e.g. i386, it now warns if KSTACK_PAGES is less than
1690	ZFS_MIN_KSTACK_PAGES (which is 4 at the time of writing).
1691
1692	Please consider using 'options KSTACK_PAGES=X' where X is greater
1693	than or equal to ZFS_MIN_KSTACK_PAGES i.e. 4 in such configurations.
1694
169520150706:
1696	sendmail has been updated to 8.15.2.  Starting with FreeBSD 11.0
1697	and sendmail 8.15, sendmail uses uncompressed IPv6 addresses by
1698	default, i.e., they will not contain "::".  For example, instead
1699	of ::1, it will be 0:0:0:0:0:0:0:1.  This permits a zero subnet
1700	to have a more specific match, such as different map entries for
1701	IPv6:0:0 vs IPv6:0.  This change requires that configuration
1702	data (including maps, files, classes, custom ruleset, etc.) must
1703	use the same format, so make certain such configuration data is
1704	upgrading.  As a very simple check search for patterns like
1705	'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'.  To return to the old
1706	behavior, set the m4 option confUSE_COMPRESSED_IPV6_ADDRESSES or
1707	the cf option UseCompressedIPv6Addresses.
1708
170920150630:
1710	The default kernel entropy-processing algorithm is now
1711	Fortuna, replacing Yarrow.
1712
1713	Assuming you have 'device random' in your kernel config
1714	file, the configurations allow a kernel option to override
1715	this default. You may choose *ONE* of:
1716
1717	options	RANDOM_YARROW	# Legacy /dev/random algorithm.
1718	options	RANDOM_DUMMY	# Blocking-only driver.
1719
1720	If you have neither, you get Fortuna.  For most people,
1721	read no further, Fortuna will give a /dev/random that works
1722	like it always used to, and the difference will be irrelevant.
1723
1724	If you remove 'device random', you get *NO* kernel-processed
1725	entropy at all. This may be acceptable to folks building
1726	embedded systems, but has complications. Carry on reading,
1727	and it is assumed you know what you need.
1728
1729	*PLEASE* read random(4) and random(9) if you are in the
1730	habit of tweaking kernel configs, and/or if you are a member
1731	of the embedded community, wanting specific and not-usual
1732	behaviour from your security subsystems.
1733
1734	NOTE!! If you use RANDOM_DUMMY and/or have no 'device
1735	random', you will NOT have a functioning /dev/random, and
1736	many cryptographic features will not work, including SSH.
1737	You may also find strange behaviour from the random(3) set
1738	of library functions, in particular sranddev(3), srandomdev(3)
1739	and arc4random(3). The reason for this is that the KERN_ARND
1740	sysctl only returns entropy if it thinks it has some to
1741	share, and with RANDOM_DUMMY or no 'device random' this
1742	will never happen.
1743
174420150623:
1745	An additional fix for the issue described in the 20150614 sendmail
1746	entry below has been committed in revision 284717.
1747
174820150616:
1749	FreeBSD's old make (fmake) has been removed from the system. It is
1750	available as the devel/fmake port or via pkg install fmake.
1751
175220150615:
1753	The fix for the issue described in the 20150614 sendmail entry
1754	below has been committed in revision 284436.  The work
1755	around described in that entry is no longer needed unless the
1756	default setting is overridden by a confDH_PARAMETERS configuration
1757	setting of '5' or pointing to a 512 bit DH parameter file.
1758
175920150614:
1760	ALLOW_DEPRECATED_ATF_TOOLS/ATFFILE support has been removed from
1761	atf.test.mk (included from bsd.test.mk). Please upgrade devel/atf
1762	and devel/kyua to version 0.20+ and adjust any calling code to work
1763	with Kyuafile and kyua.
1764
176520150614:
1766	The import of openssl to address the FreeBSD-SA-15:10.openssl
1767	security advisory includes a change which rejects handshakes
1768	with DH parameters below 768 bits.  sendmail releases prior
1769	to 8.15.2 (not yet released), defaulted to a 512 bit
1770	DH parameter setting for client connections.  To work around
1771	this interoperability, sendmail can be configured to use a
1772	2048 bit DH parameter by:
1773
1774	1. Edit /etc/mail/`hostname`.mc
1775	2. If a setting for confDH_PARAMETERS does not exist or
1776	   exists and is set to a string beginning with '5',
1777	   replace it with '2'.
1778	3. If a setting for confDH_PARAMETERS exists and is set to
1779	   a file path, create a new file with:
1780		openssl dhparam -out /path/to/file 2048
1781	4. Rebuild the .cf file:
1782		cd /etc/mail/; make; make install
1783	5. Restart sendmail:
1784		cd /etc/mail/; make restart
1785
1786	A sendmail patch is coming, at which time this file will be
1787	updated.
1788
178920150604:
1790	Generation of legacy formatted entries have been disabled by default
1791	in pwd_mkdb(8), as all base system consumers of the legacy formatted
1792	entries were converted to use the new format by default when the new,
1793	machine independent format have been added and supported since FreeBSD
1794	5.x.
1795
1796	Please see the pwd_mkdb(8) manual page for further details.
1797
179820150525:
1799	Clang and llvm have been upgraded to 3.6.1 release.  Please see the
1800	20141231 entry below for information about prerequisites and upgrading,
1801	if you are not already using 3.5.0 or higher.
1802
180320150521:
1804	TI platform code switched to using vendor DTS files and this update
1805	may break existing systems running on Beaglebone, Beaglebone Black,
1806	and Pandaboard:
1807
1808	- dtb files should be regenerated/reinstalled. Filenames are the
1809	  same but content is different now
1810	- GPIO addressing was changed, now each GPIO bank (32 pins per bank)
1811	  has its own /dev/gpiocX device, e.g. pin 121 on /dev/gpioc0 in old
1812	  addressing scheme is now pin 25 on /dev/gpioc3.
1813	- Pandaboard: /etc/ttys should be updated, serial console device is
1814	  now /dev/ttyu2, not /dev/ttyu0
1815
181620150501:
1817	soelim(1) from gnu/usr.bin/groff has been replaced by usr.bin/soelim.
1818	If you need the GNU extension from groff soelim(1), install groff
1819	from package: pkg install groff, or via ports: textproc/groff.
1820
182120150423:
1822	chmod, chflags, chown and chgrp now affect symlinks in -R mode as
1823	defined in symlink(7); previously symlinks were silently ignored.
1824
182520150415:
1826	The const qualifier has been removed from iconv(3) to comply with
1827	POSIX.  The ports tree is aware of this from r384038 onwards.
1828
182920150416:
1830	Libraries specified by LIBADD in Makefiles must have a corresponding
1831	DPADD_<lib> variable to ensure correct dependencies.  This is now
1832	enforced in src.libnames.mk.
1833
183420150324:
1835	From legacy ata(4) driver was removed support for SATA controllers
1836	supported by more functional drivers ahci(4), siis(4) and mvs(4).
1837	Kernel modules ataahci and ataadaptec were removed completely,
1838	replaced by ahci and mvs modules respectively.
1839
184020150315:
1841	Clang, llvm and lldb have been upgraded to 3.6.0 release.  Please see
1842	the 20141231 entry below for information about prerequisites and
1843	upgrading, if you are not already using 3.5.0 or higher.
1844
184520150307:
1846	The 32-bit PowerPC kernel has been changed to a position-independent
1847	executable. This can only be booted with a version of loader(8)
1848	newer than January 31, 2015, so make sure to update both world and
1849	kernel before rebooting.
1850
185120150217:
1852	If you are running a -CURRENT kernel since r273872 (Oct 30th, 2014),
1853	but before r278950, the RNG was not seeded properly.  Immediately
1854	upgrade the kernel to r278950 or later and regenerate any keys (e.g.
1855	ssh keys or openssl keys) that were generated w/ a kernel from that
1856	range.  This does not affect programs that directly used /dev/random
1857	or /dev/urandom.  All userland uses of arc4random(3) are affected.
1858
185920150210:
1860	The autofs(4) ABI was changed in order to restore binary compatibility
1861	with 10.1-RELEASE.  The automountd(8) daemon needs to be rebuilt to work
1862	with the new kernel.
1863
186420150131:
1865	The powerpc64 kernel has been changed to a position-independent
1866	executable. This can only be booted with a new version of loader(8),
1867	so make sure to update both world and kernel before rebooting.
1868
186920150118:
1870	Clang and llvm have been upgraded to 3.5.1 release.  This is a bugfix
1871	only release, no new features have been added.  Please see the 20141231
1872	entry below for information about prerequisites and upgrading, if you
1873	are not already using 3.5.0.
1874
187520150107:
1876	ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
1877	taken from the ELF Tool Chain project rather than GNU binutils. They
1878	should be drop-in replacements, with the addition of arm64 support.
1879	The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
1880	binutils tools, if necessary. See 20150805 for updated information.
1881
188220150105:
1883	The default Unbound configuration now enables remote control
1884	using a local socket.  Users who have already enabled the
1885	local_unbound service should regenerate their configuration
1886	by running "service local_unbound setup" as root.
1887
188820150102:
1889	The GNU texinfo and GNU info pages have been removed.
1890	To be able to view GNU info pages please install texinfo from ports.
1891
189220141231:
1893	Clang, llvm and lldb have been upgraded to 3.5.0 release.
1894
1895	As of this release, a prerequisite for building clang, llvm and lldb is
1896	a C++11 capable compiler and C++11 standard library.  This means that to
1897	be able to successfully build the cross-tools stage of buildworld, with
1898	clang as the bootstrap compiler, your system compiler or cross compiler
1899	should either be clang 3.3 or later, or gcc 4.8 or later, and your
1900	system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
1901	later.
1902
1903	On any standard FreeBSD 10.x or 11.x installation, where clang and
1904	libc++ are on by default (that is, on x86 or arm), this should work out
1905	of the box.
1906
1907	On 9.x installations where clang is enabled by default, e.g. on x86 and
1908	powerpc, libc++ will not be enabled by default, so libc++ should be
1909	built (with clang) and installed first.  If both clang and libc++ are
1910	missing, build clang first, then use it to build libc++.
1911
1912	On 8.x and earlier installations, upgrade to 9.x first, and then follow
1913	the instructions for 9.x above.
1914
1915	Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
1916	default, and do not build clang.
1917
1918	Many embedded systems are resource constrained, and will not be able to
1919	build clang in a reasonable time, or in some cases at all.  In those
1920	cases, cross building bootable systems on amd64 is a workaround.
1921
1922	This new version of clang introduces a number of new warnings, of which
1923	the following are most likely to appear:
1924
1925	-Wabsolute-value
1926
1927	This warns in two cases, for both C and C++:
1928	* When the code is trying to take the absolute value of an unsigned
1929	  quantity, which is effectively a no-op, and almost never what was
1930	  intended.  The code should be fixed, if at all possible.  If you are
1931	  sure that the unsigned quantity can be safely cast to signed, without
1932	  loss of information or undefined behavior, you can add an explicit
1933	  cast, or disable the warning.
1934
1935	* When the code is trying to take an absolute value, but the called
1936	  abs() variant is for the wrong type, which can lead to truncation.
1937	  If you want to disable the warning instead of fixing the code, please
1938	  make sure that truncation will not occur, or it might lead to unwanted
1939	  side-effects.
1940
1941	-Wtautological-undefined-compare and
1942	-Wundefined-bool-conversion
1943
1944	These warn when C++ code is trying to compare 'this' against NULL, while
1945	'this' should never be NULL in well-defined C++ code.  However, there is
1946	some legacy (pre C++11) code out there, which actively abuses this
1947	feature, which was less strictly defined in previous C++ versions.
1948
1949	Squid and openjdk do this, for example.  The warning can be turned off
1950	for C++98 and earlier, but compiling the code in C++11 mode might result
1951	in unexpected behavior; for example, the parts of the program that are
1952	unreachable could be optimized away.
1953
195420141222:
1955	The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
1956	kernel sources have been removed. The .h files remain, since some
1957	utilities include them. This will need to be fixed later.
1958	If "mount -t oldnfs ..." is attempted, it will fail.
1959	If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
1960	the utilities will report errors.
1961
196220141121:
1963	The handling of LOCAL_LIB_DIRS has been altered to skip addition of
1964	directories to top level SUBDIR variable when their parent
1965	directory is included in LOCAL_DIRS.  Users with build systems with
1966	such hierarchies and without SUBDIR entries in the parent
1967	directory Makefiles should add them or add the directories to
1968	LOCAL_DIRS.
1969
197020141109:
1971	faith(4) and faithd(8) have been removed from the base system. Faith
1972	has been obsolete for a very long time.
1973
197420141104:
1975	vt(4), the new console driver, is enabled by default. It brings
1976	support for Unicode and double-width characters, as well as
1977	support for UEFI and integration with the KMS kernel video
1978	drivers.
1979
1980	You may need to update your console settings in /etc/rc.conf,
1981	most probably the keymap. During boot, /etc/rc.d/syscons will
1982	indicate what you need to do.
1983
1984	vt(4) still has issues and lacks some features compared to
1985	syscons(4). See the wiki for up-to-date information:
1986	  https://wiki.freebsd.org/Newcons
1987
1988	If you want to keep using syscons(4), you can do so by adding
1989	the following line to /boot/loader.conf:
1990	  kern.vty=sc
1991
199220141102:
1993	pjdfstest has been integrated into kyua as an opt-in test suite.
1994	Please see share/doc/pjdfstest/README for more details on how to
1995	execute it.
1996
199720141009:
1998	gperf has been removed from the base system for architectures
1999	that use clang. Ports that require gperf will obtain it from the
2000	devel/gperf port.
2001
200220140923:
2003	pjdfstest has been moved from tools/regression/pjdfstest to
2004	contrib/pjdfstest .
2005
200620140922:
2007	At svn r271982, The default linux compat kernel ABI has been adjusted
2008	to 2.6.18 in support of the linux-c6 compat ports infrastructure
2009	update.  If you wish to continue using the linux-f10 compat ports,
2010	add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
2011	encouraged to update their linux-compat packages to linux-c6 during
2012	their next update cycle.
2013
201420140729:
2015	The ofwfb driver, used to provide a graphics console on PowerPC when
2016	using vt(4), no longer allows mmap() of all physical memory. This
2017	will prevent Xorg on PowerPC with some ATI graphics cards from
2018	initializing properly unless x11-servers/xorg-server is updated to
2019	1.12.4_8 or newer.
2020
202120140723:
2022	The xdev targets have been converted to using TARGET and
2023	TARGET_ARCH instead of XDEV and XDEV_ARCH.
2024
202520140719:
2026	The default unbound configuration has been modified to address
2027	issues with reverse lookups on networks that use private
2028	address ranges.  If you use the local_unbound service, run
2029	"service local_unbound setup" as root to regenerate your
2030	configuration, then "service local_unbound reload" to load the
2031	new configuration.
2032
203320140709:
2034	The GNU texinfo and GNU info pages are not built and installed
2035	anymore, WITH_INFO knob has been added to allow to built and install
2036	them again.
2037	UPDATE: see 20150102 entry on texinfo's removal
2038
203920140708:
2040	The GNU readline library is now an INTERNALLIB - that is, it is
2041	statically linked into consumers (GDB and variants) in the base
2042	system, and the shared library is no longer installed.  The
2043	devel/readline port is available for third party software that
2044	requires readline.
2045
204620140702:
2047	The Itanium architecture (ia64) has been removed from the list of
2048	known architectures. This is the first step in the removal of the
2049	architecture.
2050
205120140701:
2052	Commit r268115 has added NFSv4.1 server support, merged from
2053	projects/nfsv4.1-server.  Since this includes changes to the
2054	internal interfaces between the NFS related modules, a full
2055	build of the kernel and modules will be necessary.
2056	__FreeBSD_version has been bumped.
2057
205820140629:
2059	The WITHOUT_VT_SUPPORT kernel config knob has been renamed
2060	WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
2061	which differs from the behaviour controlled by this knob.)
2062
206320140619:
2064	Maximal length of the serial number in CTL was increased from 16 to
2065	64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
2066	and ctld, need to be rebuilt to work with a new kernel.
2067
206820140606:
2069	The libatf-c and libatf-c++ major versions were downgraded to 0 and
2070	1 respectively to match the upstream numbers.  They were out of
2071	sync because, when they were originally added to FreeBSD, the
2072	upstream versions were not respected.  These libraries are private
2073	and not yet built by default, so renumbering them should be a
2074	non-issue.  However, unclean source trees will yield broken test
2075	programs once the operator executes "make delete-old-libs" after a
2076	"make installworld".
2077
2078	Additionally, the atf-sh binary was made private by moving it into
2079	/usr/libexec/.  Already-built shell test programs will keep the
2080	path to the old binary so they will break after "make delete-old"
2081	is run.
2082
2083	If you are using WITH_TESTS=yes (not the default), wipe the object
2084	tree and rebuild from scratch to prevent spurious test failures.
2085	This is only needed once: the misnumbered libraries and misplaced
2086	binaries have been added to OptionalObsoleteFiles.inc so they will
2087	be removed during a clean upgrade.
2088
208920140512:
2090	Clang and llvm have been upgraded to 3.4.1 release.
2091
209220140508:
2093	We bogusly installed src.opts.mk in /usr/share/mk. This file should
2094	be removed to avoid issues in the future (and has been added to
2095	ObsoleteFiles.inc).
2096
209720140505:
2098	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
2099	past, it affected all builds that used the bsd.*.mk files. The old
2100	behavior was a bug, but people may have relied upon it. To get this
2101	behavior back, you can .include /etc/src.conf from /etc/make.conf
2102	(which is still global and isn't changed). This also changes the
2103	behavior of incremental builds inside the tree of individual
2104	directories. Set MAKESYSPATH to ".../share/mk" to do that.
2105	Although this has survived make universe and some upgrade scenarios,
2106	other upgrade scenarios may have broken. At least one form of
2107	temporary breakage was fixed with MAKESYSPATH settings for buildworld
2108	as well... In cases where MAKESYSPATH isn't working with this
2109	setting, you'll need to set it to the full path to your tree.
2110
2111	One side effect of all this cleaning up is that bsd.compiler.mk
2112	is no longer implicitly included by bsd.own.mk. If you wish to
2113	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
2114	as well.
2115
211620140430:
2117	The lindev device has been removed since /dev/full has been made a
2118	standard device.  __FreeBSD_version has been bumped.
2119
212020140424:
2121	The knob WITHOUT_VI was added to the base system, which controls
2122	building ex(1), vi(1), etc. Older releases of FreeBSD required ex(1)
2123	in order to reorder files share/termcap and didn't build ex(1) as a
2124	build tool, so building/installing with WITH_VI is highly advised for
2125	build hosts for older releases.
2126
2127	This issue has been fixed in stable/9 and stable/10 in r277022 and
2128	r276991, respectively.
2129
213020140418:
2131	The YES_HESIOD knob has been removed. It has been obsolete for
2132	a decade. Please move to using WITH_HESIOD instead or your builds
2133	will silently lack HESIOD.
2134
213520140405:
2136	The uart(4) driver has been changed with respect to its handling
2137	of the low-level console. Previously the uart(4) driver prevented
2138	any process from changing the baudrate or the CLOCAL and HUPCL
2139	control flags. By removing the restrictions, operators can make
2140	changes to the serial console port without having to reboot.
2141	However, when getty(8) is started on the serial device that is
2142	associated with the low-level console, a misconfigured terminal
2143	line in /etc/ttys will now have a real impact.
2144	Before upgrading the kernel, make sure that /etc/ttys has the
2145	serial console device configured as 3wire without baudrate to
2146	preserve the previous behaviour. E.g:
2147	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
2148
214920140306:
2150	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
2151	to improve performance.  To re-enable it, if needed, run rpcbind
2152	with command line option -W.
2153
215420140226:
2155	Switched back to the GPL dtc compiler due to updates in the upstream
2156	dts files not being supported by the BSDL dtc compiler. You will need
2157	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
2158	may result while building dtb files during a kernel build if you fail
2159	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
2160
216120140216:
2162	Clang and llvm have been upgraded to 3.4 release.
2163
216420140216:
2165	The nve(4) driver has been removed.  Please use the nfe(4) driver
2166	for NVIDIA nForce MCP Ethernet adapters instead.
2167
216820140212:
2169	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
2170	This could cause certain C++ applications using shared libraries built
2171	against the previous version of libc++ to crash.  The incompatibility
2172	has now been fixed, but any C++ applications or shared libraries built
2173	between r261283 and r261801 should be recompiled.
2174
217520140204:
2176	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
2177	capability mode support.  Please note that enabling the feature in
2178	kernel is still highly recommended.
2179
218020140131:
2181	OpenSSH is now built with sandbox support, and will use sandbox as
2182	the default privilege separation method.  This requires Capsicum
2183	capability mode support in kernel.
2184
218520140128:
2186	The libelf and libdwarf libraries have been updated to newer
2187	versions from upstream. Shared library version numbers for
2188	these two libraries were bumped. Any ports or binaries
2189	requiring these two libraries should be recompiled.
2190	__FreeBSD_version is bumped to 1100006.
2191
219220140110:
2193	If a Makefile in a tests/ directory was auto-generating a Kyuafile
2194	instead of providing an explicit one, this would prevent such
2195	Makefile from providing its own Kyuafile in the future during
2196	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
2197	intervention is needed to clean an objdir if you use NO_CLEAN:
2198	  # find /usr/obj -name Kyuafile | xargs rm -f
2199
220020131213:
2201	The behavior of gss_pseudo_random() for the krb5 mechanism
2202	has changed, for applications requesting a longer random string
2203	than produced by the underlying enctype's pseudo-random() function.
2204	In particular, the random string produced from a session key of
2205	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
2206	be different at the 17th octet and later, after this change.
2207	The counter used in the PRF+ construction is now encoded as a
2208	big-endian integer in accordance with RFC 4402.
2209	__FreeBSD_version is bumped to 1100004.
2210
221120131108:
2212	The WITHOUT_ATF build knob has been removed and its functionality
2213	has been subsumed into the more generic WITHOUT_TESTS.  If you were
2214	using the former to disable the build of the ATF libraries, you
2215	should change your settings to use the latter.
2216
221720131025:
2218	The default version of mtree is nmtree which is obtained from
2219	NetBSD.  The output is generally the same, but may vary
2220	slightly.  If you found you need identical output adding
2221	"-F freebsd9" to the command line should do the trick.  For the
2222	time being, the old mtree is available as fmtree.
2223
222420131014:
2225	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
2226	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
2227	1.1.4_8 and verify bsdyml not linked in, before running "make
2228	delete-old-libs":
2229	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
2230	  or
2231	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
2232
223320131010:
2234	The stable/10 branch has been created in subversion from head
2235	revision r256279.
2236
2237COMMON ITEMS:
2238
2239	General Notes
2240	-------------
2241	Sometimes, obscure build problems are the result of environment
2242	poisoning.  This can happen because the make utility reads its
2243	environment when searching for values for global variables.  To run
2244	your build attempts in an "environmental clean room", prefix all make
2245	commands with 'env -i '.  See the env(1) manual page for more details.
2246	Occasionally a build failure will occur with "make -j" due to a race
2247	condition.  If this happens try building again without -j, and please
2248	report a bug if it happens consistently.
2249
2250	When upgrading from one major version to another it is generally best to
2251	upgrade to the latest code in the currently installed branch first, then
2252	do an upgrade to the new branch. This is the best-tested upgrade path,
2253	and has the highest probability of being successful.  Please try this
2254	approach if you encounter problems with a major version upgrade.  Since
2255	the stable 4.x branch point, one has generally been able to upgrade from
2256	anywhere in the most recent stable branch to head / current (or even the
2257	last couple of stable branches). See the top of this file when there's
2258	an exception.
2259
2260	The update process will emit an error on an attempt to perform a build
2261	or install from a FreeBSD version below the earliest supported version.
2262	When updating from an older version the update should be performed one
2263	major release at a time, including running `make delete-old` at each
2264	step.
2265
2266	When upgrading a live system, having a root shell around before
2267	installing anything can help undo problems. Not having a root shell
2268	around can lead to problems if pam has changed too much from your
2269	starting point to allow continued authentication after the upgrade.
2270
2271	This file should be read as a log of events. When a later event changes
2272	information of a prior event, the prior event should not be deleted.
2273	Instead, a pointer to the entry with the new information should be
2274	placed in the old entry. Readers of this file should also sanity check
2275	older entries before relying on them blindly. Authors of new entries
2276	should write them with this in mind.
2277
2278	ZFS notes
2279	---------
2280	When upgrading the boot ZFS pool to a new version, always follow
2281	these two steps:
2282
2283	1.) recompile and reinstall the ZFS boot loader and boot block
2284	(this is part of "make buildworld" and "make installworld")
2285
2286	2.) update the ZFS boot block on your boot drive
2287
2288	The following example updates the ZFS boot block on the
2289	freebsd-boot partition of a GPT partitioned drive ada0:
2290	"gpart bootcode -p /boot/gptzfsboot -i $N ada0"
2291	The value $N will typically be 1 (if booting from BIOS) or 2 (if
2292	booting from EFI).
2293
2294	Non-boot pools do not need these updates.
2295
2296	To build a kernel
2297	-----------------
2298	If you are updating from a prior version of FreeBSD (even one just
2299	a few days old), you should follow this procedure.  It is the most
2300	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
2301
2302	make kernel-toolchain
2303	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
2304	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
2305
2306	To test a kernel once
2307	---------------------
2308	If you just want to boot a kernel once (because you are not sure
2309	if it works, or if you want to boot a known bad kernel to provide
2310	debugging information) run
2311	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
2312	nextboot -k testkernel
2313
2314	To rebuild everything and install it on the current system.
2315	-----------------------------------------------------------
2316	# Note: sometimes if you are running current you gotta do more than
2317	# is listed here if you are upgrading from a really old current.
2318
2319	<make sure you have good level 0 dumps>
2320	make buildworld
2321	make buildkernel KERNCONF=YOUR_KERNEL_HERE
2322	make installkernel KERNCONF=YOUR_KERNEL_HERE
2323							[1]
2324	<reboot in single user>				[3]
2325	mergemaster -Fp					[5]
2326	make installworld
2327	mergemaster -Fi					[4]
2328	make delete-old					[6]
2329	<reboot>
2330
2331	To cross-install current onto a separate partition
2332	--------------------------------------------------
2333	# In this approach we use a separate partition to hold
2334	# current's root, 'usr', and 'var' directories.   A partition
2335	# holding "/", "/usr" and "/var" should be about 2GB in
2336	# size.
2337
2338	<make sure you have good level 0 dumps>
2339	<boot into -stable>
2340	make buildworld
2341	make buildkernel KERNCONF=YOUR_KERNEL_HERE
2342	<maybe newfs current's root partition>
2343	<mount current's root partition on directory ${CURRENT_ROOT}>
2344	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
2345	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
2346	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
2347	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
2348	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
2349	<reboot into current>
2350	<do a "native" rebuild/install as described in the previous section>
2351	<maybe install compatibility libraries from ports/misc/compat*>
2352	<reboot>
2353
2354
2355	To upgrade in-place from stable to current
2356	----------------------------------------------
2357	<make sure you have good level 0 dumps>
2358	make buildworld					[9]
2359	make buildkernel KERNCONF=YOUR_KERNEL_HERE	[8]
2360	make installkernel KERNCONF=YOUR_KERNEL_HERE
2361							[1]
2362	<reboot in single user>				[3]
2363	mergemaster -Fp					[5]
2364	make installworld
2365	mergemaster -Fi					[4]
2366	make delete-old					[6]
2367	<reboot>
2368
2369	Make sure that you've read the UPDATING file to understand the
2370	tweaks to various things you need.  At this point in the life
2371	cycle of current, things change often and you are on your own
2372	to cope.  The defaults can also change, so please read ALL of
2373	the UPDATING entries.
2374
2375	Also, if you are tracking -current, you must be subscribed to
2376	freebsd-current@freebsd.org.  Make sure that before you update
2377	your sources that you have read and understood all the recent
2378	messages there.  If in doubt, please track -stable which has
2379	much fewer pitfalls.
2380
2381	[1] If you have third party modules, such as vmware, you should disable
2382	them at this point so they don't crash your system on
2383	reboot. Alternatively, you should rebuild all the modules you have in
2384	your system and install them as well.  If you are running -current, you
2385	should seriously consider placing all sources to all the modules for
2386	your system (or symlinks to them) in /usr/local/sys/modules so this
2387	happens automatically. If all your modules come from ports, then adding
2388	the port origin directories to PORTS_MODULES instead is also automatic
2389	and effective, eg:
2390	     PORTS_MODULES+=x11/nvidia-driver
2391
2392	[3] From the bootblocks, boot -s, and then do
2393		fsck -p
2394		mount -u /
2395		mount -a
2396		sh /etc/rc.d/zfs start	# mount zfs filesystem, if needed
2397		cd src			# full path to source
2398		adjkerntz -i		# if CMOS is wall time
2399	Also, when doing a major release upgrade, it is required that you boot
2400	into single user mode to do the installworld.
2401
2402	[4] Note: This step is non-optional.  Failure to do this step
2403	can result in a significant reduction in the functionality of the
2404	system.  Attempting to do it by hand is not recommended and those
2405	that pursue this avenue should read this file carefully, as well
2406	as the archives of freebsd-current and freebsd-hackers mailing lists
2407	for potential gotchas.  The -U option is also useful to consider.
2408	See mergemaster(8) for more information.
2409
2410	[5] Usually this step is a no-op.  However, from time to time
2411	you may need to do this if you get unknown user in the following
2412	step.  It never hurts to do it all the time.  You may need to
2413	install a new mergemaster (cd src/usr.sbin/mergemaster && make
2414	install) after the buildworld before this step if you last updated
2415	from current before 20130425 or from -stable before 20130430.
2416
2417	[6] This only deletes old files and directories. Old libraries
2418	can be deleted by "make delete-old-libs", but you have to make
2419	sure that no program is using those libraries anymore.
2420
2421	[8] The new kernel must be able to run existing binaries used by an
2422	installworld.  When upgrading across major versions, the new kernel's
2423	configuration must include the correct COMPAT_FREEBSD<n> option for
2424	existing binaries (e.g. COMPAT_FREEBSD11 to run 11.x binaries).  Failure
2425	to do so may leave you with a system that is hard to boot to recover. A
2426	GENERIC kernel will include suitable compatibility options to run
2427	binaries from older branches.  Note that the ability to run binaries
2428	from unsupported branches is not guaranteed.
2429
2430	Make sure that you merge any new devices from GENERIC since the
2431	last time you updated your kernel config file. Options also
2432	change over time, so you may need to adjust your custom kernels
2433	for these as well.
2434
2435	[9] If CPUTYPE is defined in your /etc/make.conf, make sure to use the
2436	"?=" instead of the "=" assignment operator, so that buildworld can
2437	override the CPUTYPE if it needs to.
2438
2439	MAKEOBJDIRPREFIX must be defined in an environment variable, and
2440	not on the command line, or in /etc/make.conf.  buildworld will
2441	warn if it is improperly defined.
2442FORMAT:
2443
2444This file contains a list, in reverse chronological order, of major
2445breakages in tracking -current.  It is not guaranteed to be a complete
2446list of such breakages, and only contains entries since September 23, 2011.
2447If you need to see UPDATING entries from before that date, you will need
2448to fetch an UPDATING file from an older FreeBSD release.
2449
2450Copyright information:
2451
2452Copyright 1998-2009 M. Warner Losh <imp@FreeBSD.org>
2453
2454Redistribution, publication, translation and use, with or without
2455modification, in full or in part, in any form or format of this
2456document are permitted without further permission from the author.
2457
2458THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
2459IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
2460WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
2461DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
2462INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
2463(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
2464SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2465HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
2466STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
2467IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2468POSSIBILITY OF SUCH DAMAGE.
2469
2470Contact Warner Losh if you have any questions about your use of
2471this document.
2472
2473$FreeBSD$
2474