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