xref: /freebsd/UPDATING (revision 851f1a112155b4c1404536e904b0d93dd685f4a9)
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: FreeBSD has switched from gcc to clang. If you have trouble bootstrapping
15from older versions of FreeBSD, try WITHOUT_CLANG and WITH_GCC to bootstrap to
16the tip of head, and then rebuild without this option. The bootstrap process
17from older version of current across the gcc/clang cutover is a bit fragile.
18
19NOTE TO PEOPLE WHO THINK THAT FreeBSD 13.x IS SLOW:
20	FreeBSD 13.x has many debugging features turned on, in both the kernel
21	and userland.  These features attempt to detect incorrect use of
22	system primitives, and encourage loud failure through extra sanity
23	checking and fail stop semantics.  They also substantially impact
24	system performance.  If you want to do performance measurement,
25	benchmarking, and optimization, you'll want to turn them off.  This
26	includes various WITNESS- related kernel options, INVARIANTS, malloc
27	debugging flags in userland, and various verbose features in the
28	kernel.  Many developers choose to disable these features on build
29	machines to maximize performance.  (To completely disable malloc
30	debugging, define MALLOC_PRODUCTION in /etc/make.conf, or to merely
31	disable the most expensive debugging functionality run
32	"ln -s 'abort:false,junk:false' /etc/malloc.conf".)
33
3420181110:
35	The default newsyslog.conf(5) file has been changed to only include
36	files in /etc/newsyslog.conf.d/ and /usr/local/etc/newsyslog.conf.d/ if
37	the filenames end in '.conf' and do not begin with a '.'.
38
39	You should check the configuration files in these two directories match
40	this naming convention. You can verify which configuration files are
41	being included using the command:
42		$ newsyslog -Nrv
43
4420181015:
45	Ports for the DRM modules have been simplified. Now, amd64 users should
46	just install the drm-kmod port. All others should install
47	drm-legacy-kmod.
48
49	Graphics hardware that's newer than about 2010 usually works with
50	drm-kmod.  For hardware older than 2013, however, some users will need
51	to use drm-legacy-kmod if drm-kmod doesn't work for them. Hardware older
52	than 2008 usually only works in drm-legacy-kmod. The graphics team can
53	only commit to hardware made since 2013 due to the complexity of the
54	market and difficulty to test all the older cards effectively. If you
55	have hardware supported by drm-kmod, you are strongly encouraged to use
56	that as you will get better support.
57
58	Other than KPI chasing, drm-legacy-kmod will not be updated. As outlined
59	elsewhere, the drm and drm2 modules will be eliminated from the src base
60	soon (with a limited exception for arm). Please update to the package asap
61	and report any issues to x11@freebsd.org.
62
63	Generally, anybody using the drm*-kmod packages should add
64	WITHOUT_DRM_MODULE=t and WITHOUT_DRM2_MODULE=t to avoid nasty
65	cross-threading surprises, especially with automatic driver
66	loading from X11 startup. These will become the defaults in 13-current
67	shortly.
68
6920181009:
70	OpenSSL has been updated to version 1.1.1.  This update included
71	additional various API changes througout the base system.  It is
72	important to rebuild third-party software after upgrading.  The value
73	of __FreeBSD_version has been bumped accordingly.
74
7520181006:
76	The legacy DRM modules and drivers have now been added to the loader's
77	module blacklist, in favor of loading them with kld_list in rc.conf(5).
78	The module blacklist may be overridden with the loader.conf(5)
79	'module_blacklist' variable, but loading them via rc.conf(5) is strongly
80	encouraged.
81
8220181002:
83	The cam(4) based nda(4) driver will be used over nvd(4) by default on
84	powerpc64. You may set 'options NVME_USE_NVD=1' in your kernel conf or
85	loader tunable 'hw.nvme.use_nvd=1' if you wish to use the existing
86	driver.  Make sure to edit /boot/etc/kboot.conf and fstab to use the
87	nda device name.
88
8920180913:
90	Reproducible build mode is now on by default, in preparation for
91	FreeBSD 12.0.  This eliminates build metadata such as the user,
92	host, and time from the kernel (and uname), unless the working tree
93	corresponds to a modified checkout from a version control system.
94	The previous behavior can be obtained by setting the /etc/src.conf
95	knob WITHOUT_REPRODUCIBLE_BUILD.
96
9720180826:
98	The Yarrow CSPRNG has been removed from the kernel as it has not been
99	supported by its designers since at least 2003. Fortuna has been the
100	default since FreeBSD-11.
101
10220180822:
103	devctl freeze/thaw have gone into the tree, the rc scripts have been
104	updated to use them and devmatch has been changed.  You should update
105	kernel, userland and rc scripts all at the same time.
106
10720180818:
108	The default interpreter has been switched from 4th to Lua.
109	LOADER_DEFAULT_INTERP, documented in build(7), will override the default
110	interpreter.  If you have custom FORTH code you will need to set
111	LOADER_DEFAULT_INTERP=4th (valid values are 4th, lua or simp) in
112	src.conf for the build.  This will create default hard links between
113	loader and loader_4th instead of loader and loader_lua, the new default.
114	If you are using UEFI it will create the proper hard link to loader.efi.
115
116	bhyve uses userboot.so. It remains 4th-only until some issues are solved
117	regarding coexisting with multiple versions of FreeBSD are resolved.
118
11920180815:
120	ls(1) now respects the COLORTERM environment variable used in other
121	systems and software to indicate that a colored terminal is both
122	supported and desired.  If ls(1) is suddenly emitting colors, they may
123	be disabled again by either removing the unwanted COLORTERM from your
124	environment, or using `ls --color=never`.  The ls(1) specific CLICOLOR
125	may not be observed in a future release.
126
12720180808:
128	The default pager for most commands has been changed to "less".  To
129	restore the old behavior, set PAGER="more" and MANPAGER="more -s" in
130	your environment.
131
13220180731:
133	The jedec_ts(4) driver has been removed. A superset of its functionality
134	is available in the jedec_dimm(4) driver, and the manpage for that
135	driver includes migration instructions. If you have "device jedec_ts"
136	in your kernel configuration file, it must be removed.
137
13820180730:
139	amd64/GENERIC now has EFI runtime services, EFIRT, enabled by default.
140	This should have no effect if the kernel is booted via BIOS/legacy boot.
141	EFIRT may be disabled via a loader tunable, efi.rt.disabled, if a system
142	has a buggy firmware that prevents a successful boot due to use of
143	runtime services.
144
14520180727:
146	Atmel AT91RM9200 and AT91SAM9, Cavium CNS 11xx and XScale
147	support has been removed from the tree. These ports were
148	obsolete and/or known to be broken for many years.
149
15020180723:
151	loader.efi has been augmented to participate more fully in the
152	UEFI boot manager protocol. loader.efi will now look at the
153	BootXXXX environment variable to determine if a specific kernel
154	or root partition was specified. XXXX is derived from BootCurrent.
155	efibootmgr(8) manages these standard UEFI variables.
156
15720180720:
158	zfsloader's functionality has now been folded into loader.
159	zfsloader is no longer necessary once you've updated your
160	boot blocks. For a transition period, we will install a
161	hardlink for zfsloader to loader to allow a smooth transition
162	until the boot blocks can be updated (hard link because old
163	zfs boot blocks don't understand symlinks).
164
16520180719:
166	ARM64 now have efifb support, if you want to have serial console
167	on your arm64 board when an screen is connected and the bootloader
168	setup a frambuffer for us to use, just add :
169	boot_serial=YES
170	boot_multicons=YES
171	in /boot/loader.conf
172	For Raspberry Pi 3 (RPI) users, this is needed even if you don't have
173	an screen connected as the firmware will setup a framebuffer are that
174	u-boot will expose as an EFI framebuffer.
175
17620180719:
177	New uid:gid added, ntpd:ntpd (123:123).  Be sure to run mergemaster
178	or take steps to update /etc/passwd before doing installworld on
179	existing systems.  Do not skip the "mergemaster -Fp" step before
180	installworld, as described in the update procedures near the bottom
181	of this document.  Also, rc.d/ntpd now starts ntpd(8) as user ntpd
182	if the new mac_ntpd(4) policy is available, unless ntpd_flags or
183	the ntp config file contain options that change file/dir locations.
184	When such options (e.g., "statsdir" or "crypto") are used, ntpd can
185	still be run as non-root by setting ntpd_user=ntpd in rc.conf, after
186	taking steps to ensure that all required files/dirs are accessible
187	by the ntpd user.
188
18920180717:
190	Big endian arm support has been removed.
191
19220180711:
193	The static environment setup in kernel configs is no longer mutually
194	exclusive with the loader(8) environment by default.  In order to
195	restore the previous default behavior of disabling the loader(8)
196	environment if a static environment is present, you must specify
197	loader_env.disabled=1 in the static environment.
198
19920180705:
200	The ABI of syscalls used by management tools like sockstat and
201	netstat has been broken to allow 32-bit binaries to work on
202	64-bit kernels without modification.  These programs will need
203	to match the kernel in order to function.  External programs may
204	require minor modifications to accommodate a change of type in
205	structures from pointers to 64-bit virtual addresses.
206
20720180702:
208	On i386 and amd64 atomics are now inlined. Out of tree modules using
209	atomics will need to be rebuilt.
210
21120180701:
212	The '%I' format in the kern.corefile sysctl limits the number of
213	core files that a process can generate to the number stored in the
214	debug.ncores sysctl. The '%I' format is replaced by the single digit
215	index. Previously, if all indexes were taken the kernel would overwrite
216	only a core file with the highest index in a filename.
217	Currently the system will create a new core file if there is a free
218	index or if all slots are taken it will overwrite the oldest one.
219
22020180630:
221	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
222	6.0.1.  Please see the 20141231 entry below for information about
223	prerequisites and upgrading, if you are not already using clang 3.5.0
224	or higher.
225
22620180628:
227	r335753 introduced a new quoting method. However, etc/devd/devmatch.conf
228	needed to be changed to work with it. This change was made with r335763
229	and requires a mergemaster / etcupdate / etc to update the installed file.
230
23120180612:
232	r334930 changed the interface between the NFS modules, so they all
233	need to be rebuilt.  r335018 did a __FreeBSD_version bump for this.
234
23520180530:
236	As of r334391 lld is the default amd64 system linker; it is installed
237	as /usr/bin/ld.  Kernel build workarounds (see 20180510 entry) are no
238	longer necessary.
239
24020180530:
241	The kernel / userland interface for devinfo changed, so you'll
242	need a new kernel and userland as a pair for it to work (rebuilding
243	lib/libdevinfo is all that's required). devinfo and devmatch will
244	not work, but everything else will when there's a mismatch.
245
24620180523:
247	The on-disk format for hwpmc callchain records has changed to include
248	threadid corresponding to a given record. This changes the field offsets
249	and thus requires that libpmcstat be rebuilt before using a kernel
250	later than r334108.
251
25220180517:
253	The vxge(4) driver has been removed.  This driver was introduced into
254	HEAD one week before the Exar left the Ethernet market and is not
255	known to be used.  If you have device vxge in your kernel config file
256	it must be removed.
257
25820180510:
259	The amd64 kernel now requires a ld that supports ifunc to produce a
260	working kernel, either lld or a newer binutils. lld is built by default
261	on amd64, and the 'buildkernel' target uses it automatically. However,
262	it is not the default linker, so building the kernel the traditional
263	way requires LD=ld.lld on the command line (or LD=/usr/local/bin/ld for
264	binutils port/package). lld will soon be default, and this requirement
265	will go away.
266
267	NOTE: As of r334391 lld is the default system linker on amd64, and no
268	workaround is necessary.
269
27020180508:
271	The nxge(4) driver has been removed.  This driver was for PCI-X 10g
272	cards made by s2io/Neterion.  The company was aquired by Exar and
273	no longer sells or supports Ethernet products.  If you have device
274	nxge in your kernel config file it must be removed.
275
27620180504:
277	The tz database (tzdb) has been updated to 2018e.  This version more
278	correctly models time stamps in time zones with negative DST such as
279	Europe/Dublin (from 1971 on), Europe/Prague (1946/7), and
280	Africa/Windhoek (1994/2017).  This does not affect the UT offsets, only
281	time zone abbreviations and the tm_isdst flag.
282
28320180502:
284	The ixgb(4) driver has been removed.  This driver was for an early and
285	uncommon legacy PCI 10GbE for a single ASIC, Intel 82597EX. Intel
286	quickly shifted to the long lived ixgbe family.  If you have device
287	ixgb in your kernel config file it must be removed.
288
28920180501:
290	The lmc(4) driver has been removed.  This was a WAN interface
291	card that was already reportedly rare in 2003, and had an ambiguous
292	license.  If you have device lmc in your kernel config file it must
293	be removed.
294
29520180413:
296	Support for Arcnet networks has been removed.  If you have device
297	arcnet or device cm in your kernel config file they must be
298	removed.
299
30020180411:
301	Support for FDDI networks has been removed.  If you have device
302	fddi or device fpa in your kernel config file they must be
303	removed.
304
30520180406:
306	In addition to supporting RFC 3164 formatted messages, the
307	syslogd(8) service is now capable of parsing RFC 5424 formatted
308	log messages. The main benefit of using RFC 5424 is that clients
309	may now send log messages with timestamps containing year numbers,
310	microseconds and time zone offsets.
311
312	Similarly, the syslog(3) C library function has been altered to
313	send RFC 5424 formatted messages to the local system logging
314	daemon. On systems using syslogd(8), this change should have no
315	negative impact, as long as syslogd(8) and the C library are
316	updated at the same time. On systems using a different system
317	logging daemon, it may be necessary to make configuration
318	adjustments, depending on the software used.
319
320	When using syslog-ng, add the 'syslog-protocol' flag to local
321	input sources to enable parsing of RFC 5424 formatted messages:
322
323		source src {
324			unix-dgram("/var/run/log" flags(syslog-protocol));
325		}
326
327	When using rsyslog, disable the 'SysSock.UseSpecialParser' option
328	of the 'imuxsock' module to let messages be processed by the
329	regular RFC 3164/5424 parsing pipeline:
330
331		module(load="imuxsock" SysSock.UseSpecialParser="off")
332
333	Do note that these changes only affect communication between local
334	applications and syslogd(8). The format that syslogd(8) uses to
335	store messages on disk or forward messages to other systems
336	remains unchanged. syslogd(8) still uses RFC 3164 for these
337	purposes. Options to customize this behaviour will be added in the
338	future. Utilities that process log files stored in /var/log are
339	thus expected to continue to function as before.
340
341	__FreeBSD_version has been incremented to 1200061 to denote this
342	change.
343
34420180328:
345	Support for token ring networks has been removed. If you
346	have "device token" in your kernel config you should remove
347	it. No device drivers supported token ring.
348
34920180323:
350	makefs was modified to be able to tag ISO9660 El Torito boot catalog
351	entries as EFI instead of overloading the i386 tag as done previously.
352	The amd64 mkisoimages.sh script used to build amd64 ISO images for
353	release was updated to use this. This may mean that makefs must be
354	updated before "make cdrom" can be run in the release directory. This
355	should be as simple as:
356
357		$ cd $SRCDIR/usr.sbin/makefs
358		$ make depend all install
359
36020180212:
361	FreeBSD boot loader enhanced with Lua scripting. It's purely opt-in for
362	now by building WITH_LOADER_LUA and WITHOUT_FORTH in /etc/src.conf.
363	Co-existance for the transition period will come shortly. Booting is a
364	complex environment and test coverage for Lua-enabled loaders has been
365	thin, so it would be prudent to assume it might not work and make
366	provisions for backup boot methods.
367
36820180211:
369	devmatch functionality has been turned on in devd. It will automatically
370	load drivers for unattached devices. This may cause unexpected drivers to
371	be loaded. Please report any problems to current@ and imp@freebsd.org.
372
37320180114:
374	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
375	6.0.0.  Please see the 20141231 entry below for information about
376	prerequisites and upgrading, if you are not already using clang 3.5.0
377	or higher.
378
37920180110:
380	LLVM's lld linker is now used as the FreeBSD/amd64 bootstrap linker.
381	This means it is used to link the kernel and userland libraries and
382	executables, but is not yet installed as /usr/bin/ld by default.
383
384	To revert to ld.bfd as the bootstrap linker, in /etc/src.conf set
385        WITHOUT_LLD_BOOTSTRAP=yes
386
38720180110:
388	On i386, pmtimer has been removed. Its functionality has been folded
389	into apm. It was a no-op on ACPI in current for a while now (but was still
390	needed on i386 in FreeBSD 11 and earlier). Users may need to remove it
391	from kernel config files.
392
39320180104:
394	The use of RSS hash from the network card aka flowid has been
395	disabled by default for lagg(4) as it's currently incompatible with
396	the lacp and loadbalance protocols.
397
398	This can be re-enabled by setting the following in loader.conf:
399	net.link.lagg.default_use_flowid="1"
400
40120180102:
402	The SW_WATCHDOG option is no longer necessary to enable the
403	hardclock-based software watchdog if no hardware watchdog is
404	configured. As before, SW_WATCHDOG will cause the software
405	watchdog to be enabled even if a hardware watchdog is configured.
406
40720171215:
408	r326887 fixes the issue described in the 20171214 UPDATING entry.
409	r326888 flips the switch back to building GELI support always.
410
41120171214:
412	r362593 broke ZFS + GELI support for reasons unknown. However,
413	it also broke ZFS support generally, so GELI has been turned off
414	by default as the lesser evil in r326857. If you boot off ZFS and/or
415	GELI, it might not be a good time to update.
416
41720171125:
418	PowerPC users must update loader(8) by rebuilding world before
419	installing a new kernel, as the protocol connecting them has
420	changed. Without the update, loader metadata will not be passed
421	successfully to the kernel and users will have to enter their
422	root partition at the kernel mountroot prompt to continue booting.
423	Newer versions of loader can boot old kernels without issue.
424
42520171110:
426	The LOADER_FIREWIRE_SUPPORT build variable as been renamed to
427	WITH/OUT_LOADER_FIREWIRE. LOADER_{NO_,}GELI_SUPPORT has been renamed
428	to WITH/OUT_LOADER_GELI.
429
43020171106:
431	The naive and non-compliant support of posix_fallocate(2) in ZFS
432	has been removed as of r325320.  The system call now returns EINVAL
433	when used on a ZFS file.  Although the new behavior complies with the
434	standard, some consumers are not prepared to cope with it.
435	One known victim is lld prior to r325420.
436
43720171102:
438	Building in a FreeBSD src checkout will automatically create object
439	directories now rather than store files in the current directory if
440	'make obj' was not ran.  Calling 'make obj' is no longer necessary.
441	This feature can be disabled by setting WITHOUT_AUTO_OBJ=yes in
442	/etc/src-env.conf (not /etc/src.conf), or passing the option in the
443	environment.
444
44520171101:
446	The default MAKEOBJDIR has changed from /usr/obj/<srcdir> for native
447	builds, and /usr/obj/<arch>/<srcdir> for cross-builds, to a unified
448	/usr/obj/<srcdir>/<arch>.  This behavior can be changed to the old
449	format by setting WITHOUT_UNIFIED_OBJDIR=yes in /etc/src-env.conf,
450	the environment, or with -DWITHOUT_UNIFIED_OBJDIR when building.
451	The UNIFIED_OBJDIR option is a transitional feature that will be
452	removed for 12.0 release; please migrate to the new format for any
453	tools by looking up the OBJDIR used by 'make -V .OBJDIR' means rather
454	than hardcoding paths.
455
45620171028:
457	The native-xtools target no longer installs the files by default to the
458	OBJDIR.  Use the native-xtools-install target with a DESTDIR to install
459	to ${DESTDIR}/${NXTP} where NXTP defaults to /nxb-bin.
460
46120171021:
462	As part of the boot loader infrastructure cleanup, LOADER_*_SUPPORT
463	options are changing from controlling the build if defined / undefined
464	to controlling the build with explicit 'yes' or 'no' values. They will
465	shift to WITH/WITHOUT options to match other options in the system.
466
46720171010:
468	libstand has turned into a private library for sys/boot use only.
469	It is no longer supported as a public interface outside of sys/boot.
470
47120171005:
472	The arm port has split armv6 into armv6 and armv7. armv7 is now
473	a valid TARGET_ARCH/MACHINE_ARCH setting. If you have an armv7 system
474	and are running a kernel from before r324363, you will need to add
475	MACHINE_ARCH=armv7 to 'make buildworld' to do a native build.
476
47720171003:
478	When building multiple kernels using KERNCONF, non-existent KERNCONF
479	files will produce an error and buildkernel will fail. Previously
480	missing KERNCONF files silently failed giving no indication as to
481	why, only to subsequently discover during installkernel that the
482	desired kernel was never built in the first place.
483
48420170912:
485	The default serial number format for CTL LUNs has changed.  This will
486	affect users who use /dev/diskid/* device nodes, or whose FibreChannel
487	or iSCSI clients care about their LUNs' serial numbers.  Users who
488	require serial number stability should hardcode serial numbers in
489	/etc/ctl.conf .
490
49120170912:
492	For 32-bit arm compiled for hard-float support, soft-floating point
493	binaries now always get their shared libraries from
494	LD_SOFT_LIBRARY_PATH (in the past, this was only used if
495	/usr/libsoft also existed). Only users with a hard-float ld.so, but
496	soft-float everything else should be affected.
497
49820170826:
499	The geli password typed at boot is now hidden.  To restore the previous
500	behavior, see geli(8) for configuration options.
501
50220170825:
503	Move PMTUD blackhole counters to TCPSTATS and remove them from bare
504	sysctl values.  Minor nit, but requires a rebuild of both world/kernel
505	to complete.
506
50720170814:
508	"make check" behavior (made in ^/head@r295380) has been changed to
509	execute from a limited sandbox, as opposed to executing from
510	${TESTSDIR}.
511
512	Behavioral changes:
513	- The "beforecheck" and "aftercheck" targets are now specified.
514	- ${CHECKDIR} (added in commit noted above) has been removed.
515	- Legacy behavior can be enabled by setting
516	  WITHOUT_MAKE_CHECK_USE_SANDBOX in src.conf(5) or the environment.
517
518	If the limited sandbox mode is enabled, "make check" will execute
519	"make distribution", then install, execute the tests, and clean up the
520	sandbox if successful.
521
522	The "make distribution" and "make install" targets are typically run as
523	root to set appropriate permissions and ownership at installation time.
524	The end-user should set "WITH_INSTALL_AS_USER" in src.conf(5) or the
525	environment if executing "make check" with limited sandbox mode using
526	an unprivileged user.
527
52820170808:
529	Since the switch to GPT disk labels, fsck for UFS/FFS has been
530	unable to automatically find alternate superblocks. As of r322297,
531	the information needed to find alternate superblocks has been
532	moved to the end of the area reserved for the boot block.
533	Filesystems created with a newfs of this vintage or later
534	will create the recovery information. If you have a filesystem
535	created prior to this change and wish to have a recovery block
536	created for your filesystem, you can do so by running fsck in
537	foreground mode (i.e., do not use the -p or -y options). As it
538	starts, fsck will ask ``SAVE DATA TO FIND ALTERNATE SUPERBLOCKS''
539	to which you should answer yes.
540
54120170728:
542	As of r321665, an NFSv4 server configuration that services
543	Kerberos mounts or clients that do not support the uid/gid in
544	owner/owner_group string capability, must explicitly enable
545	the nfsuserd daemon by adding nfsuserd_enable="YES" to the
546	machine's /etc/rc.conf file.
547
54820170722:
549	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 5.0.0.
550	Please see the 20141231 entry below for information about prerequisites
551	and upgrading, if you are not already using clang 3.5.0 or higher.
552
55320170701:
554	WITHOUT_RCMDS is now the default. Set WITH_RCMDS if you need the
555	r-commands (rlogin, rsh, etc.) to be built with the base system.
556
55720170625:
558	The FreeBSD/powerpc platform now uses a 64-bit type for time_t.  This is
559	a very major ABI incompatible change, so users of FreeBSD/powerpc must
560	be careful when performing source upgrades.  It is best to run
561	'make installworld' from an alternate root system, either a live
562	CD/memory stick, or a temporary root partition.  Additionally, all ports
563	must be recompiled.  powerpc64 is largely unaffected, except in the case
564	of 32-bit compatibility.  All 32-bit binaries will be affected.
565
56620170623:
567	Forward compatibility for the "ino64" project have been committed. This
568	will allow most new binaries to run on older kernels in a limited
569	fashion.  This prevents many of the common foot-shooting actions in the
570	upgrade as well as the limited ability to roll back the kernel across
571	the ino64 upgrade. Complicated use cases may not work properly, though
572	enough simpler ones work to allow recovery in most situations.
573
57420170620:
575	Switch back to the BSDL dtc (Device Tree Compiler). Set WITH_GPL_DTC
576	if you require the GPL compiler.
577
57820170618:
579	The internal ABI used for communication between the NFS kernel modules
580	was changed by r320085, so __FreeBSD_version was bumped to
581	ensure all the NFS related modules are updated together.
582
58320170617:
584	The ABI of struct event was changed by extending the data
585	member to 64bit and adding ext fields.  For upgrade, same
586	precautions as for the entry 20170523 "ino64" must be
587	followed.
588
58920170531:
590	The GNU roff toolchain has been removed from base. To render manpages
591	which are not supported by mandoc(1), man(1) can fallback on GNU roff
592	from ports (and recommends to install it).
593	To render roff(7) documents, consider using GNU roff from ports or the
594	heirloom doctools roff toolchain from ports via pkg install groff or
595	via pkg install heirloom-doctools.
596
59720170524:
598	The ath(4) and ath_hal(4) modules now build piecemeal to allow for
599	smaller runtime footprint builds.  This is useful for embedded systems
600	which only require one chipset support.
601
602	If you load it as a module, make sure this is in /boot/loader.conf:
603
604	if_ath_load="YES"
605
606	This will load the HAL, all chip/RF backends and if_ath_pci.
607	If you have if_ath_pci in /boot/loader.conf, ensure it is after
608	if_ath or it will not load any HAL chipset support.
609
610	If you want to selectively load things (eg on ye cheape ARM/MIPS
611	platforms where RAM is at a premium) you should:
612
613	* load ath_hal
614	* load the chip modules in question
615	* load ath_rate, ath_dfs
616	* load ath_main
617	* load if_ath_pci and/or if_ath_ahb depending upon your particular
618	  bus bind type - this is where probe/attach is done.
619
620	For further comments/feedback, poke adrian@ .
621
62220170523:
623	The "ino64" 64-bit inode project has been committed, which extends
624	a number of types to 64 bits.  Upgrading in place requires care and
625	adherence to the documented upgrade procedure.
626
627	If using a custom kernel configuration ensure that the
628	COMPAT_FREEBSD11 option is included (as during the upgrade the
629	system will be running the ino64 kernel with the existing world).
630
631	For the safest in-place upgrade begin by removing previous build
632	artifacts via "rm -rf /usr/obj/*".   Then, carefully follow the
633	full procedure documented below under the heading "To rebuild
634	everything and install it on the current system."  Specifically,
635	a reboot is required after installing the new kernel before
636	installing world.
637
63820170424:
639	The NATM framework including the en(4), fatm(4), hatm(4), and
640	patm(4) devices has been removed.  Consumers should plan a
641	migration before the end-of-life date for FreeBSD 11.
642
64320170420:
644	GNU diff has been replaced by a BSD licensed diff. Some features of GNU
645	diff has not been implemented, if those are needed a newer version of
646	GNU diff is available via the diffutils package under the gdiff name.
647
64820170413:
649	As of r316810 for ipfilter, keep frags is no longer assumed when
650	keep state is specified in a rule. r316810 aligns ipfilter with
651	documentation in man pages separating keep frags from keep state.
652	This allows keep state to be specified without forcing keep frags
653	and allows keep frags to be specified independently of keep state.
654	To maintain previous behaviour, also specify keep frags with
655	keep state (as documented in ipf.conf.5).
656
65720170407:
658	arm64 builds now use the base system LLD 4.0.0 linker by default,
659	instead of requiring that the aarch64-binutils port or package be
660	installed. To continue using aarch64-binutils, set
661	CROSS_BINUTILS_PREFIX=/usr/local/aarch64-freebsd/bin .
662
66320170405:
664	The UDP optimization in entry 20160818 that added the sysctl
665	net.inet.udp.require_l2_bcast has been reverted.  L2 broadcast
666	packets will no longer be treated as L3 broadcast packets.
667
66820170331:
669	Binds and sends to the loopback addresses, IPv6 and IPv4, will now
670	use any explicitly assigned loopback address available in the jail
671	instead of using the first assigned address of the jail.
672
67320170329:
674	The ctl.ko module no longer implements the iSCSI target frontend:
675	cfiscsi.ko does instead.
676
677	If building cfiscsi.ko as a kernel module, the module can be loaded
678	via one of the following methods:
679	- `cfiscsi_load="YES"` in loader.conf(5).
680	- Add `cfiscsi` to `$kld_list` in rc.conf(5).
681	- ctladm(8)/ctld(8), when compiled with iSCSI support
682	  (`WITH_ISCSI=yes` in src.conf(5))
683
684	Please see cfiscsi(4) for more details.
685
68620170316:
687	The mmcsd.ko module now additionally depends on geom_flashmap.ko.
688	Also, mmc.ko and mmcsd.ko need to be a matching pair built from the
689	same source (previously, the dependency of mmcsd.ko on mmc.ko was
690	missing, but mmcsd.ko now will refuse to load if it is incompatible
691	with mmc.ko).
692
69320170315:
694	The syntax of ipfw(8) named states was changed to avoid ambiguity.
695	If you have used named states in the firewall rules, you need to modify
696	them after installworld and before rebooting. Now named states must
697	be prefixed with colon.
698
69920170311:
700	The old drm (sys/dev/drm/) drivers for i915 and radeon have been
701	removed as the userland we provide cannot use them. The KMS version
702	(sys/dev/drm2) supports the same hardware.
703
70420170302:
705	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 4.0.0.
706	Please see the 20141231 entry below for information about prerequisites
707	and upgrading, if you are not already using clang 3.5.0 or higher.
708
70920170221:
710	The code that provides support for ZFS .zfs/ directory functionality
711	has been reimplemented.  It's not possible now to create a snapshot
712	by mkdir under .zfs/snapshot/.  That should be the only user visible
713	change.
714
71520170216:
716	EISA bus support has been removed. The WITH_EISA option is no longer
717	valid.
718
71920170215:
720	MCA bus support has been removed.
721
72220170127:
723	The WITH_LLD_AS_LD / WITHOUT_LLD_AS_LD build knobs have been renamed
724	WITH_LLD_IS_LD / WITHOUT_LLD_IS_LD, for consistency with CLANG_IS_CC.
725
72620170112:
727	The EM_MULTIQUEUE kernel configuration option is deprecated now that
728	the em(4) driver conforms to iflib specifications.
729
73020170109:
731	The igb(4), em(4) and lem(4) ethernet drivers are now implemented via
732	IFLIB.  If you have a custom kernel configuration that excludes em(4)
733	but you use igb(4), you need to re-add em(4) to your custom configuration.
734
73520161217:
736	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.1.
737	Please see the 20141231 entry below for information about prerequisites
738	and upgrading, if you are not already using clang 3.5.0 or higher.
739
74020161124:
741	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.0.
742	Please see the 20141231 entry below for information about prerequisites
743	and upgrading, if you are not already using clang 3.5.0 or higher.
744
74520161119:
746	The layout of the pmap structure has changed for powerpc to put the pmap
747	statistics at the front for all CPU variations.  libkvm(3) and all tools
748	that link against it need to be recompiled.
749
75020161030:
751	isl(4) and cyapa(4) drivers now require a new driver,
752	chromebook_platform(4), to work properly on Chromebook-class hardware.
753	On other types of hardware the drivers may need to be configured using
754	device hints.  Please see the corresponding manual pages for details.
755
75620161017:
757	The urtwn(4) driver was merged into rtwn(4) and now consists of
758	rtwn(4) main module + rtwn_usb(4) and rtwn_pci(4) bus-specific
759	parts.
760	Also, firmware for RTL8188CE was renamed due to possible name
761	conflict (rtwnrtl8192cU(B) -> rtwnrtl8192cE(B))
762
76320161015:
764	GNU rcs has been removed from base.  It is available as packages:
765	- rcs: Latest GPLv3 GNU rcs version.
766	- rcs57: Copy of the latest version of GNU rcs (GPLv2) before it was
767	removed from base.
768
76920161008:
770	Use of the cc_cdg, cc_chd, cc_hd, or cc_vegas congestion control
771	modules now requires that the kernel configuration contain the
772	TCP_HHOOK option. (This option is included in the GENERIC kernel.)
773
77420161003:
775	The WITHOUT_ELFCOPY_AS_OBJCOPY src.conf(5) knob has been retired.
776	ELF Tool Chain's elfcopy is always installed as /usr/bin/objcopy.
777
77820160924:
779	Relocatable object files with the extension of .So have been renamed
780	to use an extension of .pico instead.  The purpose of this change is
781	to avoid a name clash with shared libraries on case-insensitive file
782	systems.  On those file systems, foo.So is the same file as foo.so.
783
78420160918:
785	GNU rcs has been turned off by default.  It can (temporarily) be built
786	again by adding WITH_RCS knob in src.conf.
787	Otherwise, GNU rcs is available from packages:
788	- rcs: Latest GPLv3 GNU rcs version.
789	- rcs57: Copy of the latest version of GNU rcs (GPLv2) from base.
790
79120160918:
792	The backup_uses_rcs functionality has been removed from rc.subr.
793
79420160908:
795	The queue(3) debugging macro, QUEUE_MACRO_DEBUG, has been split into
796	two separate components, QUEUE_MACRO_DEBUG_TRACE and
797	QUEUE_MACRO_DEBUG_TRASH.  Define both for the original
798	QUEUE_MACRO_DEBUG behavior.
799
80020160824:
801	r304787 changed some ioctl interfaces between the iSCSI userspace
802	programs and the kernel.  ctladm, ctld, iscsictl, and iscsid must be
803	rebuilt to work with new kernels.  __FreeBSD_version has been bumped
804	to 1200005.
805
80620160818:
807	The UDP receive code has been updated to only treat incoming UDP
808	packets that were addressed to an L2 broadcast address as L3
809	broadcast packets.  It is not expected that this will affect any
810	standards-conforming UDP application.  The new behaviour can be
811	disabled by setting the sysctl net.inet.udp.require_l2_bcast to
812	0.
813
81420160818:
815	Remove the openbsd_poll system call.
816	__FreeBSD_version has been bumped because of this.
817
81820160708:
819	The stable/11 branch has been created from head@r302406.
820
82120160622:
822	The libc stub for the pipe(2) system call has been replaced with
823	a wrapper that calls the pipe2(2) system call and the pipe(2)
824	system call is now only implemented by the kernels that include
825	"options COMPAT_FREEBSD10" in their config file (this is the
826	default).  Users should ensure that this option is enabled in
827	their kernel or upgrade userspace to r302092 before upgrading their
828	kernel.
829
83020160527:
831	CAM will now strip leading spaces from SCSI disks' serial numbers.
832	This will affect users who create UFS filesystems on SCSI disks using
833	those disk's diskid device nodes.  For example, if /etc/fstab
834	previously contained a line like
835	"/dev/diskid/DISK-%20%20%20%20%20%20%20ABCDEFG0123456", you should
836	change it to "/dev/diskid/DISK-ABCDEFG0123456".  Users of geom
837	transforms like gmirror may also be affected.  ZFS users should
838	generally be fine.
839
84020160523:
841	The bitstring(3) API has been updated with new functionality and
842	improved performance.  But it is binary-incompatible with the old API.
843	Objects built with the new headers may not be linked against objects
844	built with the old headers.
845
84620160520:
847	The brk and sbrk functions have been removed from libc on arm64.
848	Binutils from ports has been updated to not link to these
849	functions and should be updated to the latest version before
850	installing a new libc.
851
85220160517:
853	The armv6 port now defaults to hard float ABI. Limited support
854	for running both hardfloat and soft float on the same system
855	is available using the libraries installed with -DWITH_LIBSOFT.
856	This has only been tested as an upgrade path for installworld
857	and packages may fail or need manual intervention to run. New
858	packages will be needed.
859
860	To update an existing self-hosted armv6hf system, you must add
861	TARGET_ARCH=armv6 on the make command line for both the build
862	and the install steps.
863
86420160510:
865	Kernel modules compiled outside of a kernel build now default to
866	installing to /boot/modules instead of /boot/kernel.  Many kernel
867	modules built this way (such as those in ports) already overrode
868	KMODDIR explicitly to install into /boot/modules.  However,
869	manually building and installing a module from /sys/modules will
870	now install to /boot/modules instead of /boot/kernel.
871
87220160414:
873	The CAM I/O scheduler has been committed to the kernel. There should be
874	no user visible impact. This does enable NCQ Trim on ada SSDs. While the
875	list of known rogues that claim support for this but actually corrupt
876	data is believed to be complete, be on the lookout for data
877	corruption. The known rogue list is believed to be complete:
878
879		o Crucial MX100, M550 drives with MU01 firmware.
880		o Micron M510 and M550 drives with MU01 firmware.
881		o Micron M500 prior to MU07 firmware
882		o Samsung 830, 840, and 850 all firmwares
883		o FCCT M500 all firmwares
884
885	Crucial has firmware http://www.crucial.com/usa/en/support-ssd-firmware
886	with working NCQ TRIM. For Micron branded drives, see your sales rep for
887	updated firmware. Black listed drives will work correctly because these
888	drives work correctly so long as no NCQ TRIMs are sent to them. Given
889	this list is the same as found in Linux, it's believed there are no
890	other rogues in the market place. All other models from the above
891	vendors work.
892
893	To be safe, if you are at all concerned, you can quirk each of your
894	drives to prevent NCQ from being sent by setting:
895		kern.cam.ada.X.quirks="0x2"
896	in loader.conf. If the drive requires the 4k sector quirk, set the
897	quirks entry to 0x3.
898
89920160330:
900	The FAST_DEPEND build option has been removed and its functionality is
901	now the one true way.  The old mkdep(1) style of 'make depend' has
902	been removed.  See 20160311 for further details.
903
90420160317:
905	Resource range types have grown from unsigned long to uintmax_t.  All
906	drivers, and anything using libdevinfo, need to be recompiled.
907
90820160311:
909	WITH_FAST_DEPEND is now enabled by default for in-tree and out-of-tree
910	builds.  It no longer runs mkdep(1) during 'make depend', and the
911	'make depend' stage can safely be skipped now as it is auto ran
912	when building 'make all' and will generate all SRCS and DPSRCS before
913	building anything else.  Dependencies are gathered at compile time with
914	-MF flags kept in separate .depend files per object file.  Users should
915	run 'make cleandepend' once if using -DNO_CLEAN to clean out older
916	stale .depend files.
917
91820160306:
919	On amd64, clang 3.8.0 can now insert sections of type AMD64_UNWIND into
920	kernel modules.  Therefore, if you load any kernel modules at boot time,
921	please install the boot loaders after you install the kernel, but before
922	rebooting, e.g.:
923
924	make buildworld
925	make buildkernel KERNCONF=YOUR_KERNEL_HERE
926	make installkernel KERNCONF=YOUR_KERNEL_HERE
927	make -C sys/boot install
928	<reboot in single user>
929
930	Then follow the usual steps, described in the General Notes section,
931	below.
932
93320160305:
934	Clang, llvm, lldb and compiler-rt have been upgraded to 3.8.0.  Please
935	see the 20141231 entry below for information about prerequisites and
936	upgrading, if you are not already using clang 3.5.0 or higher.
937
93820160301:
939	The AIO subsystem is now a standard part of the kernel.  The
940	VFS_AIO kernel option and aio.ko kernel module have been removed.
941	Due to stability concerns, asynchronous I/O requests are only
942	permitted on sockets and raw disks by default.  To enable
943	asynchronous I/O requests on all file types, set the
944	vfs.aio.enable_unsafe sysctl to a non-zero value.
945
94620160226:
947	The ELF object manipulation tool objcopy is now provided by the
948	ELF Tool Chain project rather than by GNU binutils. It should be a
949	drop-in replacement, with the addition of arm64 support. The
950	(temporary) src.conf knob WITHOUT_ELFCOPY_AS_OBJCOPY knob may be set
951	to obtain the GNU version if necessary.
952
95320160129:
954	Building ZFS pools on top of zvols is prohibited by default.  That
955	feature has never worked safely; it's always been prone to deadlocks.
956	Using a zvol as the backing store for a VM guest's virtual disk will
957	still work, even if the guest is using ZFS.  Legacy behavior can be
958	restored by setting vfs.zfs.vol.recursive=1.
959
96020160119:
961	The NONE and HPN patches has been removed from OpenSSH.  They are
962	still available in the security/openssh-portable port.
963
96420160113:
965	With the addition of ypldap(8), a new _ypldap user is now required
966	during installworld. "mergemaster -p" can be used to add the user
967	prior to installworld, as documented in the handbook.
968
96920151216:
970	The tftp loader (pxeboot) now uses the option root-path directive. As a
971	consequence it no longer looks for a pxeboot.4th file on the tftp
972	server. Instead it uses the regular /boot infrastructure as with the
973	other loaders.
974
97520151211:
976	The code to start recording plug and play data into the modules has
977	been committed. While the old tools will properly build a new kernel,
978	a number of warnings about "unknown metadata record 4" will be produced
979	for an older kldxref. To avoid such warnings, make sure to rebuild
980	the kernel toolchain (or world). Make sure that you have r292078 or
981	later when trying to build 292077 or later before rebuilding.
982
98320151207:
984	Debug data files are now built by default with 'make buildworld' and
985	installed with 'make installworld'. This facilitates debugging but
986	requires more disk space both during the build and for the installed
987	world. Debug files may be disabled by setting WITHOUT_DEBUG_FILES=yes
988	in src.conf(5).
989
99020151130:
991	r291527 changed the internal interface between the nfsd.ko and
992	nfscommon.ko modules. As such, they must both be upgraded to-gether.
993	__FreeBSD_version has been bumped because of this.
994
99520151108:
996	Add support for unicode collation strings leads to a change of
997	order of files listed by ls(1) for example. To get back to the old
998	behaviour, set LC_COLLATE environment variable to "C".
999
1000	Databases administrators will need to reindex their databases given
1001	collation results will be different.
1002
1003	Due to a bug in install(1) it is recommended to remove the ancient
1004	locales before running make installworld.
1005
1006	rm -rf /usr/share/locale/*
1007
100820151030:
1009	The OpenSSL has been upgraded to 1.0.2d.  Any binaries requiring
1010	libcrypto.so.7 or libssl.so.7 must be recompiled.
1011
101220151020:
1013	Qlogic 24xx/25xx firmware images were updated from 5.5.0 to 7.3.0.
1014	Kernel modules isp_2400_multi and isp_2500_multi were removed and
1015	should be replaced with isp_2400 and isp_2500 modules respectively.
1016
101720151017:
1018	The build previously allowed using 'make -n' to not recurse into
1019	sub-directories while showing what commands would be executed, and
1020	'make -n -n' to recursively show commands.  Now 'make -n' will recurse
1021	and 'make -N' will not.
1022
102320151012:
1024	If you specify SENDMAIL_MC or SENDMAIL_CF in make.conf, mergemaster
1025	and etcupdate will now use this file. A custom sendmail.cf is now
1026	updated via this mechanism rather than via installworld.  If you had
1027	excluded sendmail.cf in mergemaster.rc or etcupdate.conf, you may
1028	want to remove the exclusion or change it to "always install".
1029	/etc/mail/sendmail.cf is now managed the same way regardless of
1030	whether SENDMAIL_MC/SENDMAIL_CF is used.  If you are not using
1031	SENDMAIL_MC/SENDMAIL_CF there should be no change in behavior.
1032
103320151011:
1034	Compatibility shims for legacy ATA device names have been removed.
1035	It includes ATA_STATIC_ID kernel option, kern.cam.ada.legacy_aliases
1036	and kern.geom.raid.legacy_aliases loader tunables, kern.devalias.*
1037	environment variables, /dev/ad* and /dev/ar* symbolic links.
1038
103920151006:
1040	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.7.0.
1041	Please see the 20141231 entry below for information about prerequisites
1042	and upgrading, if you are not already using clang 3.5.0 or higher.
1043
104420150924:
1045	Kernel debug files have been moved to /usr/lib/debug/boot/kernel/,
1046	and renamed from .symbols to .debug. This reduces the size requirements
1047	on the boot partition or file system and provides consistency with
1048	userland debug files.
1049
1050	When using the supported kernel installation method the
1051	/usr/lib/debug/boot/kernel directory will be renamed (to kernel.old)
1052	as is done with /boot/kernel.
1053
1054	Developers wishing to maintain the historical behavior of installing
1055	debug files in /boot/kernel/ can set KERN_DEBUGDIR="" in src.conf(5).
1056
105720150827:
1058	The wireless drivers had undergone changes that remove the 'parent
1059	interface' from the ifconfig -l output. The rc.d network scripts
1060	used to check presence of a parent interface in the list, so old
1061	scripts would fail to start wireless networking. Thus, etcupdate(3)
1062	or mergemaster(8) run is required after kernel update, to update your
1063	rc.d scripts in /etc.
1064
106520150827:
1066	pf no longer supports 'scrub fragment crop' or 'scrub fragment drop-ovl'
1067	These configurations are now automatically interpreted as
1068	'scrub fragment reassemble'.
1069
107020150817:
1071	Kernel-loadable modules for the random(4) device are back. To use
1072	them, the kernel must have
1073
1074	device	random
1075	options	RANDOM_LOADABLE
1076
1077	kldload(8) can then be used to load random_fortuna.ko
1078	or random_yarrow.ko. Please note that due to the indirect
1079	function calls that the loadable modules need to provide,
1080	the build-in variants will be slightly more efficient.
1081
1082	The random(4) kernel option RANDOM_DUMMY has been retired due to
1083	unpopularity. It was not all that useful anyway.
1084
108520150813:
1086	The WITHOUT_ELFTOOLCHAIN_TOOLS src.conf(5) knob has been retired.
1087	Control over building the ELF Tool Chain tools is now provided by
1088	the WITHOUT_TOOLCHAIN knob.
1089
109020150810:
1091	The polarity of Pulse Per Second (PPS) capture events with the
1092	uart(4) driver has been corrected.  Prior to this change the PPS
1093	"assert" event corresponded to the trailing edge of a positive PPS
1094	pulse and the "clear" event was the leading edge of the next pulse.
1095
1096	As the width of a PPS pulse in a typical GPS receiver is on the
1097	order of 1 millisecond, most users will not notice any significant
1098	difference with this change.
1099
1100	Anyone who has compensated for the historical polarity reversal by
1101	configuring a negative offset equal to the pulse width will need to
1102	remove that workaround.
1103
110420150809:
1105	The default group assigned to /dev/dri entries has been changed
1106	from 'wheel' to 'video' with the id of '44'. If you want to have
1107	access to the dri devices please add yourself to the video group
1108	with:
1109
1110	# pw groupmod video -m $USER
1111
111220150806:
1113	The menu.rc and loader.rc files will now be replaced during
1114	upgrades. Please migrate local changes to menu.rc.local and
1115	loader.rc.local instead.
1116
111720150805:
1118	GNU Binutils versions of addr2line, c++filt, nm, readelf, size,
1119	strings and strip have been removed. The src.conf(5) knob
1120	WITHOUT_ELFTOOLCHAIN_TOOLS no longer provides the binutils tools.
1121
112220150728:
1123	As ZFS requires more kernel stack pages than is the default on some
1124	architectures e.g. i386, it now warns if KSTACK_PAGES is less than
1125	ZFS_MIN_KSTACK_PAGES (which is 4 at the time of writing).
1126
1127	Please consider using 'options KSTACK_PAGES=X' where X is greater
1128	than or equal to ZFS_MIN_KSTACK_PAGES i.e. 4 in such configurations.
1129
113020150706:
1131	sendmail has been updated to 8.15.2.  Starting with FreeBSD 11.0
1132	and sendmail 8.15, sendmail uses uncompressed IPv6 addresses by
1133	default, i.e., they will not contain "::".  For example, instead
1134	of ::1, it will be 0:0:0:0:0:0:0:1.  This permits a zero subnet
1135	to have a more specific match, such as different map entries for
1136	IPv6:0:0 vs IPv6:0.  This change requires that configuration
1137	data (including maps, files, classes, custom ruleset, etc.) must
1138	use the same format, so make certain such configuration data is
1139	upgrading.  As a very simple check search for patterns like
1140	'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'.  To return to the old
1141	behavior, set the m4 option confUSE_COMPRESSED_IPV6_ADDRESSES or
1142	the cf option UseCompressedIPv6Addresses.
1143
114420150630:
1145	The default kernel entropy-processing algorithm is now
1146	Fortuna, replacing Yarrow.
1147
1148	Assuming you have 'device random' in your kernel config
1149	file, the configurations allow a kernel option to override
1150	this default. You may choose *ONE* of:
1151
1152	options	RANDOM_YARROW	# Legacy /dev/random algorithm.
1153	options	RANDOM_DUMMY	# Blocking-only driver.
1154
1155	If you have neither, you get Fortuna.  For most people,
1156	read no further, Fortuna will give a /dev/random that works
1157	like it always used to, and the difference will be irrelevant.
1158
1159	If you remove 'device random', you get *NO* kernel-processed
1160	entropy at all. This may be acceptable to folks building
1161	embedded systems, but has complications. Carry on reading,
1162	and it is assumed you know what you need.
1163
1164	*PLEASE* read random(4) and random(9) if you are in the
1165	habit of tweaking kernel configs, and/or if you are a member
1166	of the embedded community, wanting specific and not-usual
1167	behaviour from your security subsystems.
1168
1169	NOTE!! If you use RANDOM_DUMMY and/or have no 'device
1170	random', you will NOT have a functioning /dev/random, and
1171	many cryptographic features will not work, including SSH.
1172	You may also find strange behaviour from the random(3) set
1173	of library functions, in particular sranddev(3), srandomdev(3)
1174	and arc4random(3). The reason for this is that the KERN_ARND
1175	sysctl only returns entropy if it thinks it has some to
1176	share, and with RANDOM_DUMMY or no 'device random' this
1177	will never happen.
1178
117920150623:
1180	An additional fix for the issue described in the 20150614 sendmail
1181	entry below has been committed in revision 284717.
1182
118320150616:
1184	FreeBSD's old make (fmake) has been removed from the system. It is
1185	available as the devel/fmake port or via pkg install fmake.
1186
118720150615:
1188	The fix for the issue described in the 20150614 sendmail entry
1189	below has been committed in revision 284436.  The work
1190	around described in that entry is no longer needed unless the
1191	default setting is overridden by a confDH_PARAMETERS configuration
1192	setting of '5' or pointing to a 512 bit DH parameter file.
1193
119420150614:
1195	ALLOW_DEPRECATED_ATF_TOOLS/ATFFILE support has been removed from
1196	atf.test.mk (included from bsd.test.mk). Please upgrade devel/atf
1197	and devel/kyua to version 0.20+ and adjust any calling code to work
1198	with Kyuafile and kyua.
1199
120020150614:
1201	The import of openssl to address the FreeBSD-SA-15:10.openssl
1202	security advisory includes a change which rejects handshakes
1203	with DH parameters below 768 bits.  sendmail releases prior
1204	to 8.15.2 (not yet released), defaulted to a 512 bit
1205	DH parameter setting for client connections.  To work around
1206	this interoperability, sendmail can be configured to use a
1207	2048 bit DH parameter by:
1208
1209	1. Edit /etc/mail/`hostname`.mc
1210	2. If a setting for confDH_PARAMETERS does not exist or
1211	   exists and is set to a string beginning with '5',
1212	   replace it with '2'.
1213	3. If a setting for confDH_PARAMETERS exists and is set to
1214	   a file path, create a new file with:
1215		openssl dhparam -out /path/to/file 2048
1216	4. Rebuild the .cf file:
1217		cd /etc/mail/; make; make install
1218	5. Restart sendmail:
1219		cd /etc/mail/; make restart
1220
1221	A sendmail patch is coming, at which time this file will be
1222	updated.
1223
122420150604:
1225	Generation of legacy formatted entries have been disabled by default
1226	in pwd_mkdb(8), as all base system consumers of the legacy formatted
1227	entries were converted to use the new format by default when the new,
1228	machine independent format have been added and supported since FreeBSD
1229	5.x.
1230
1231	Please see the pwd_mkdb(8) manual page for further details.
1232
123320150525:
1234	Clang and llvm have been upgraded to 3.6.1 release.  Please see the
1235	20141231 entry below for information about prerequisites and upgrading,
1236	if you are not already using 3.5.0 or higher.
1237
123820150521:
1239	TI platform code switched to using vendor DTS files and this update
1240	may break existing systems running on Beaglebone, Beaglebone Black,
1241	and Pandaboard:
1242
1243	- dtb files should be regenerated/reinstalled. Filenames are the
1244	  same but content is different now
1245	- GPIO addressing was changed, now each GPIO bank (32 pins per bank)
1246	  has its own /dev/gpiocX device, e.g. pin 121 on /dev/gpioc0 in old
1247	  addressing scheme is now pin 25 on /dev/gpioc3.
1248	- Pandaboard: /etc/ttys should be updated, serial console device is
1249	  now /dev/ttyu2, not /dev/ttyu0
1250
125120150501:
1252	soelim(1) from gnu/usr.bin/groff has been replaced by usr.bin/soelim.
1253	If you need the GNU extension from groff soelim(1), install groff
1254	from package: pkg install groff, or via ports: textproc/groff.
1255
125620150423:
1257	chmod, chflags, chown and chgrp now affect symlinks in -R mode as
1258	defined in symlink(7); previously symlinks were silently ignored.
1259
126020150415:
1261	The const qualifier has been removed from iconv(3) to comply with
1262	POSIX.  The ports tree is aware of this from r384038 onwards.
1263
126420150416:
1265	Libraries specified by LIBADD in Makefiles must have a corresponding
1266	DPADD_<lib> variable to ensure correct dependencies.  This is now
1267	enforced in src.libnames.mk.
1268
126920150324:
1270	From legacy ata(4) driver was removed support for SATA controllers
1271	supported by more functional drivers ahci(4), siis(4) and mvs(4).
1272	Kernel modules ataahci and ataadaptec were removed completely,
1273	replaced by ahci and mvs modules respectively.
1274
127520150315:
1276	Clang, llvm and lldb have been upgraded to 3.6.0 release.  Please see
1277	the 20141231 entry below for information about prerequisites and
1278	upgrading, if you are not already using 3.5.0 or higher.
1279
128020150307:
1281	The 32-bit PowerPC kernel has been changed to a position-independent
1282	executable. This can only be booted with a version of loader(8)
1283	newer than January 31, 2015, so make sure to update both world and
1284	kernel before rebooting.
1285
128620150217:
1287	If you are running a -CURRENT kernel since r273872 (Oct 30th, 2014),
1288	but before r278950, the RNG was not seeded properly.  Immediately
1289	upgrade the kernel to r278950 or later and regenerate any keys (e.g.
1290	ssh keys or openssl keys) that were generated w/ a kernel from that
1291	range.  This does not affect programs that directly used /dev/random
1292	or /dev/urandom.  All userland uses of arc4random(3) are affected.
1293
129420150210:
1295	The autofs(4) ABI was changed in order to restore binary compatibility
1296	with 10.1-RELEASE.  The automountd(8) daemon needs to be rebuilt to work
1297	with the new kernel.
1298
129920150131:
1300	The powerpc64 kernel has been changed to a position-independent
1301	executable. This can only be booted with a new version of loader(8),
1302	so make sure to update both world and kernel before rebooting.
1303
130420150118:
1305	Clang and llvm have been upgraded to 3.5.1 release.  This is a bugfix
1306	only release, no new features have been added.  Please see the 20141231
1307	entry below for information about prerequisites and upgrading, if you
1308	are not already using 3.5.0.
1309
131020150107:
1311	ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
1312	taken from the ELF Tool Chain project rather than GNU binutils. They
1313	should be drop-in replacements, with the addition of arm64 support.
1314	The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
1315	binutils tools, if necessary. See 20150805 for updated information.
1316
131720150105:
1318	The default Unbound configuration now enables remote control
1319	using a local socket.  Users who have already enabled the
1320	local_unbound service should regenerate their configuration
1321	by running "service local_unbound setup" as root.
1322
132320150102:
1324	The GNU texinfo and GNU info pages have been removed.
1325	To be able to view GNU info pages please install texinfo from ports.
1326
132720141231:
1328	Clang, llvm and lldb have been upgraded to 3.5.0 release.
1329
1330	As of this release, a prerequisite for building clang, llvm and lldb is
1331	a C++11 capable compiler and C++11 standard library.  This means that to
1332	be able to successfully build the cross-tools stage of buildworld, with
1333	clang as the bootstrap compiler, your system compiler or cross compiler
1334	should either be clang 3.3 or later, or gcc 4.8 or later, and your
1335	system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
1336	later.
1337
1338	On any standard FreeBSD 10.x or 11.x installation, where clang and
1339	libc++ are on by default (that is, on x86 or arm), this should work out
1340	of the box.
1341
1342	On 9.x installations where clang is enabled by default, e.g. on x86 and
1343	powerpc, libc++ will not be enabled by default, so libc++ should be
1344	built (with clang) and installed first.  If both clang and libc++ are
1345	missing, build clang first, then use it to build libc++.
1346
1347	On 8.x and earlier installations, upgrade to 9.x first, and then follow
1348	the instructions for 9.x above.
1349
1350	Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
1351	default, and do not build clang.
1352
1353	Many embedded systems are resource constrained, and will not be able to
1354	build clang in a reasonable time, or in some cases at all.  In those
1355	cases, cross building bootable systems on amd64 is a workaround.
1356
1357	This new version of clang introduces a number of new warnings, of which
1358	the following are most likely to appear:
1359
1360	-Wabsolute-value
1361
1362	This warns in two cases, for both C and C++:
1363	* When the code is trying to take the absolute value of an unsigned
1364	  quantity, which is effectively a no-op, and almost never what was
1365	  intended.  The code should be fixed, if at all possible.  If you are
1366	  sure that the unsigned quantity can be safely cast to signed, without
1367	  loss of information or undefined behavior, you can add an explicit
1368	  cast, or disable the warning.
1369
1370	* When the code is trying to take an absolute value, but the called
1371	  abs() variant is for the wrong type, which can lead to truncation.
1372	  If you want to disable the warning instead of fixing the code, please
1373	  make sure that truncation will not occur, or it might lead to unwanted
1374	  side-effects.
1375
1376	-Wtautological-undefined-compare and
1377	-Wundefined-bool-conversion
1378
1379	These warn when C++ code is trying to compare 'this' against NULL, while
1380	'this' should never be NULL in well-defined C++ code.  However, there is
1381	some legacy (pre C++11) code out there, which actively abuses this
1382	feature, which was less strictly defined in previous C++ versions.
1383
1384	Squid and openjdk do this, for example.  The warning can be turned off
1385	for C++98 and earlier, but compiling the code in C++11 mode might result
1386	in unexpected behavior; for example, the parts of the program that are
1387	unreachable could be optimized away.
1388
138920141222:
1390	The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
1391	kernel sources have been removed. The .h files remain, since some
1392	utilities include them. This will need to be fixed later.
1393	If "mount -t oldnfs ..." is attempted, it will fail.
1394	If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
1395	the utilities will report errors.
1396
139720141121:
1398	The handling of LOCAL_LIB_DIRS has been altered to skip addition of
1399	directories to top level SUBDIR variable when their parent
1400	directory is included in LOCAL_DIRS.  Users with build systems with
1401	such hierarchies and without SUBDIR entries in the parent
1402	directory Makefiles should add them or add the directories to
1403	LOCAL_DIRS.
1404
140520141109:
1406	faith(4) and faithd(8) have been removed from the base system. Faith
1407	has been obsolete for a very long time.
1408
140920141104:
1410	vt(4), the new console driver, is enabled by default. It brings
1411	support for Unicode and double-width characters, as well as
1412	support for UEFI and integration with the KMS kernel video
1413	drivers.
1414
1415	You may need to update your console settings in /etc/rc.conf,
1416	most probably the keymap. During boot, /etc/rc.d/syscons will
1417	indicate what you need to do.
1418
1419	vt(4) still has issues and lacks some features compared to
1420	syscons(4). See the wiki for up-to-date information:
1421	  https://wiki.freebsd.org/Newcons
1422
1423	If you want to keep using syscons(4), you can do so by adding
1424	the following line to /boot/loader.conf:
1425	  kern.vty=sc
1426
142720141102:
1428	pjdfstest has been integrated into kyua as an opt-in test suite.
1429	Please see share/doc/pjdfstest/README for more details on how to
1430	execute it.
1431
143220141009:
1433	gperf has been removed from the base system for architectures
1434	that use clang. Ports that require gperf will obtain it from the
1435	devel/gperf port.
1436
143720140923:
1438	pjdfstest has been moved from tools/regression/pjdfstest to
1439	contrib/pjdfstest .
1440
144120140922:
1442	At svn r271982, The default linux compat kernel ABI has been adjusted
1443	to 2.6.18 in support of the linux-c6 compat ports infrastructure
1444	update.  If you wish to continue using the linux-f10 compat ports,
1445	add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
1446	encouraged to update their linux-compat packages to linux-c6 during
1447	their next update cycle.
1448
144920140729:
1450	The ofwfb driver, used to provide a graphics console on PowerPC when
1451	using vt(4), no longer allows mmap() of all physical memory. This
1452	will prevent Xorg on PowerPC with some ATI graphics cards from
1453	initializing properly unless x11-servers/xorg-server is updated to
1454	1.12.4_8 or newer.
1455
145620140723:
1457	The xdev targets have been converted to using TARGET and
1458	TARGET_ARCH instead of XDEV and XDEV_ARCH.
1459
146020140719:
1461	The default unbound configuration has been modified to address
1462	issues with reverse lookups on networks that use private
1463	address ranges.  If you use the local_unbound service, run
1464	"service local_unbound setup" as root to regenerate your
1465	configuration, then "service local_unbound reload" to load the
1466	new configuration.
1467
146820140709:
1469	The GNU texinfo and GNU info pages are not built and installed
1470	anymore, WITH_INFO knob has been added to allow to built and install
1471	them again.
1472	UPDATE: see 20150102 entry on texinfo's removal
1473
147420140708:
1475	The GNU readline library is now an INTERNALLIB - that is, it is
1476	statically linked into consumers (GDB and variants) in the base
1477	system, and the shared library is no longer installed.  The
1478	devel/readline port is available for third party software that
1479	requires readline.
1480
148120140702:
1482	The Itanium architecture (ia64) has been removed from the list of
1483	known architectures. This is the first step in the removal of the
1484	architecture.
1485
148620140701:
1487	Commit r268115 has added NFSv4.1 server support, merged from
1488	projects/nfsv4.1-server.  Since this includes changes to the
1489	internal interfaces between the NFS related modules, a full
1490	build of the kernel and modules will be necessary.
1491	__FreeBSD_version has been bumped.
1492
149320140629:
1494	The WITHOUT_VT_SUPPORT kernel config knob has been renamed
1495	WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
1496	which differs from the behaviour controlled by this knob.)
1497
149820140619:
1499	Maximal length of the serial number in CTL was increased from 16 to
1500	64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
1501	and ctld, need to be rebuilt to work with a new kernel.
1502
150320140606:
1504	The libatf-c and libatf-c++ major versions were downgraded to 0 and
1505	1 respectively to match the upstream numbers.  They were out of
1506	sync because, when they were originally added to FreeBSD, the
1507	upstream versions were not respected.  These libraries are private
1508	and not yet built by default, so renumbering them should be a
1509	non-issue.  However, unclean source trees will yield broken test
1510	programs once the operator executes "make delete-old-libs" after a
1511	"make installworld".
1512
1513	Additionally, the atf-sh binary was made private by moving it into
1514	/usr/libexec/.  Already-built shell test programs will keep the
1515	path to the old binary so they will break after "make delete-old"
1516	is run.
1517
1518	If you are using WITH_TESTS=yes (not the default), wipe the object
1519	tree and rebuild from scratch to prevent spurious test failures.
1520	This is only needed once: the misnumbered libraries and misplaced
1521	binaries have been added to OptionalObsoleteFiles.inc so they will
1522	be removed during a clean upgrade.
1523
152420140512:
1525	Clang and llvm have been upgraded to 3.4.1 release.
1526
152720140508:
1528	We bogusly installed src.opts.mk in /usr/share/mk. This file should
1529	be removed to avoid issues in the future (and has been added to
1530	ObsoleteFiles.inc).
1531
153220140505:
1533	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
1534	past, it affected all builds that used the bsd.*.mk files. The old
1535	behavior was a bug, but people may have relied upon it. To get this
1536	behavior back, you can .include /etc/src.conf from /etc/make.conf
1537	(which is still global and isn't changed). This also changes the
1538	behavior of incremental builds inside the tree of individual
1539	directories. Set MAKESYSPATH to ".../share/mk" to do that.
1540	Although this has survived make universe and some upgrade scenarios,
1541	other upgrade scenarios may have broken. At least one form of
1542	temporary breakage was fixed with MAKESYSPATH settings for buildworld
1543	as well... In cases where MAKESYSPATH isn't working with this
1544	setting, you'll need to set it to the full path to your tree.
1545
1546	One side effect of all this cleaning up is that bsd.compiler.mk
1547	is no longer implicitly included by bsd.own.mk. If you wish to
1548	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
1549	as well.
1550
155120140430:
1552	The lindev device has been removed since /dev/full has been made a
1553	standard device.  __FreeBSD_version has been bumped.
1554
155520140424:
1556	The knob WITHOUT_VI was added to the base system, which controls
1557	building ex(1), vi(1), etc. Older releases of FreeBSD required ex(1)
1558	in order to reorder files share/termcap and didn't build ex(1) as a
1559	build tool, so building/installing with WITH_VI is highly advised for
1560	build hosts for older releases.
1561
1562	This issue has been fixed in stable/9 and stable/10 in r277022 and
1563	r276991, respectively.
1564
156520140418:
1566	The YES_HESIOD knob has been removed. It has been obsolete for
1567	a decade. Please move to using WITH_HESIOD instead or your builds
1568	will silently lack HESIOD.
1569
157020140405:
1571	The uart(4) driver has been changed with respect to its handling
1572	of the low-level console. Previously the uart(4) driver prevented
1573	any process from changing the baudrate or the CLOCAL and HUPCL
1574	control flags. By removing the restrictions, operators can make
1575	changes to the serial console port without having to reboot.
1576	However, when getty(8) is started on the serial device that is
1577	associated with the low-level console, a misconfigured terminal
1578	line in /etc/ttys will now have a real impact.
1579	Before upgrading the kernel, make sure that /etc/ttys has the
1580	serial console device configured as 3wire without baudrate to
1581	preserve the previous behaviour. E.g:
1582	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
1583
158420140306:
1585	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
1586	to improve performance.  To re-enable it, if needed, run rpcbind
1587	with command line option -W.
1588
158920140226:
1590	Switched back to the GPL dtc compiler due to updates in the upstream
1591	dts files not being supported by the BSDL dtc compiler. You will need
1592	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
1593	may result while building dtb files during a kernel build if you fail
1594	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
1595
159620140216:
1597	Clang and llvm have been upgraded to 3.4 release.
1598
159920140216:
1600	The nve(4) driver has been removed.  Please use the nfe(4) driver
1601	for NVIDIA nForce MCP Ethernet adapters instead.
1602
160320140212:
1604	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
1605	This could cause certain C++ applications using shared libraries built
1606	against the previous version of libc++ to crash.  The incompatibility
1607	has now been fixed, but any C++ applications or shared libraries built
1608	between r261283 and r261801 should be recompiled.
1609
161020140204:
1611	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
1612	capability mode support.  Please note that enabling the feature in
1613	kernel is still highly recommended.
1614
161520140131:
1616	OpenSSH is now built with sandbox support, and will use sandbox as
1617	the default privilege separation method.  This requires Capsicum
1618	capability mode support in kernel.
1619
162020140128:
1621	The libelf and libdwarf libraries have been updated to newer
1622	versions from upstream. Shared library version numbers for
1623	these two libraries were bumped. Any ports or binaries
1624	requiring these two libraries should be recompiled.
1625	__FreeBSD_version is bumped to 1100006.
1626
162720140110:
1628	If a Makefile in a tests/ directory was auto-generating a Kyuafile
1629	instead of providing an explicit one, this would prevent such
1630	Makefile from providing its own Kyuafile in the future during
1631	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
1632	intervention is needed to clean an objdir if you use NO_CLEAN:
1633	  # find /usr/obj -name Kyuafile | xargs rm -f
1634
163520131213:
1636	The behavior of gss_pseudo_random() for the krb5 mechanism
1637	has changed, for applications requesting a longer random string
1638	than produced by the underlying enctype's pseudo-random() function.
1639	In particular, the random string produced from a session key of
1640	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
1641	be different at the 17th octet and later, after this change.
1642	The counter used in the PRF+ construction is now encoded as a
1643	big-endian integer in accordance with RFC 4402.
1644	__FreeBSD_version is bumped to 1100004.
1645
164620131108:
1647	The WITHOUT_ATF build knob has been removed and its functionality
1648	has been subsumed into the more generic WITHOUT_TESTS.  If you were
1649	using the former to disable the build of the ATF libraries, you
1650	should change your settings to use the latter.
1651
165220131025:
1653	The default version of mtree is nmtree which is obtained from
1654	NetBSD.  The output is generally the same, but may vary
1655	slightly.  If you found you need identical output adding
1656	"-F freebsd9" to the command line should do the trick.  For the
1657	time being, the old mtree is available as fmtree.
1658
165920131014:
1660	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
1661	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
1662	1.1.4_8 and verify bsdyml not linked in, before running "make
1663	delete-old-libs":
1664	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
1665	  or
1666	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
1667
166820131010:
1669	The stable/10 branch has been created in subversion from head
1670	revision r256279.
1671
1672COMMON ITEMS:
1673
1674	General Notes
1675	-------------
1676	Avoid using make -j when upgrading.  While generally safe, there are
1677	sometimes problems using -j to upgrade.  If your upgrade fails with
1678	-j, please try again without -j.  From time to time in the past there
1679	have been problems using -j with buildworld and/or installworld.  This
1680	is especially true when upgrading between "distant" versions (eg one
1681	that cross a major release boundary or several minor releases, or when
1682	several months have passed on the -current branch).
1683
1684	Sometimes, obscure build problems are the result of environment
1685	poisoning.  This can happen because the make utility reads its
1686	environment when searching for values for global variables.  To run
1687	your build attempts in an "environmental clean room", prefix all make
1688	commands with 'env -i '.  See the env(1) manual page for more details.
1689
1690	When upgrading from one major version to another it is generally best to
1691	upgrade to the latest code in the currently installed branch first, then
1692	do an upgrade to the new branch. This is the best-tested upgrade path,
1693	and has the highest probability of being successful.  Please try this
1694	approach if you encounter problems with a major version upgrade.  Since
1695	the stable 4.x branch point, one has generally been able to upgrade from
1696	anywhere in the most recent stable branch to head / current (or even the
1697	last couple of stable branches). See the top of this file when there's
1698	an exception.
1699
1700	When upgrading a live system, having a root shell around before
1701	installing anything can help undo problems. Not having a root shell
1702	around can lead to problems if pam has changed too much from your
1703	starting point to allow continued authentication after the upgrade.
1704
1705	This file should be read as a log of events. When a later event changes
1706	information of a prior event, the prior event should not be deleted.
1707	Instead, a pointer to the entry with the new information should be
1708	placed in the old entry. Readers of this file should also sanity check
1709	older entries before relying on them blindly. Authors of new entries
1710	should write them with this in mind.
1711
1712	ZFS notes
1713	---------
1714	When upgrading the boot ZFS pool to a new version, always follow
1715	these two steps:
1716
1717	1.) recompile and reinstall the ZFS boot loader and boot block
1718	(this is part of "make buildworld" and "make installworld")
1719
1720	2.) update the ZFS boot block on your boot drive
1721
1722	The following example updates the ZFS boot block on the first
1723	partition (freebsd-boot) of a GPT partitioned drive ada0:
1724	"gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
1725
1726	Non-boot pools do not need these updates.
1727
1728	To build a kernel
1729	-----------------
1730	If you are updating from a prior version of FreeBSD (even one just
1731	a few days old), you should follow this procedure.  It is the most
1732	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1733
1734	make kernel-toolchain
1735	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1736	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1737
1738	To test a kernel once
1739	---------------------
1740	If you just want to boot a kernel once (because you are not sure
1741	if it works, or if you want to boot a known bad kernel to provide
1742	debugging information) run
1743	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1744	nextboot -k testkernel
1745
1746	To rebuild everything and install it on the current system.
1747	-----------------------------------------------------------
1748	# Note: sometimes if you are running current you gotta do more than
1749	# is listed here if you are upgrading from a really old current.
1750
1751	<make sure you have good level 0 dumps>
1752	make buildworld
1753	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1754	make installkernel KERNCONF=YOUR_KERNEL_HERE
1755							[1]
1756	<reboot in single user>				[3]
1757	mergemaster -Fp					[5]
1758	make installworld
1759	mergemaster -Fi					[4]
1760	make delete-old					[6]
1761	<reboot>
1762
1763	To cross-install current onto a separate partition
1764	--------------------------------------------------
1765	# In this approach we use a separate partition to hold
1766	# current's root, 'usr', and 'var' directories.   A partition
1767	# holding "/", "/usr" and "/var" should be about 2GB in
1768	# size.
1769
1770	<make sure you have good level 0 dumps>
1771	<boot into -stable>
1772	make buildworld
1773	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1774	<maybe newfs current's root partition>
1775	<mount current's root partition on directory ${CURRENT_ROOT}>
1776	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
1777	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1778	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1779	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
1780	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1781	<reboot into current>
1782	<do a "native" rebuild/install as described in the previous section>
1783	<maybe install compatibility libraries from ports/misc/compat*>
1784	<reboot>
1785
1786
1787	To upgrade in-place from stable to current
1788	----------------------------------------------
1789	<make sure you have good level 0 dumps>
1790	make buildworld					[9]
1791	make buildkernel KERNCONF=YOUR_KERNEL_HERE	[8]
1792	make installkernel KERNCONF=YOUR_KERNEL_HERE
1793							[1]
1794	<reboot in single user>				[3]
1795	mergemaster -Fp					[5]
1796	make installworld
1797	mergemaster -Fi					[4]
1798	make delete-old					[6]
1799	<reboot>
1800
1801	Make sure that you've read the UPDATING file to understand the
1802	tweaks to various things you need.  At this point in the life
1803	cycle of current, things change often and you are on your own
1804	to cope.  The defaults can also change, so please read ALL of
1805	the UPDATING entries.
1806
1807	Also, if you are tracking -current, you must be subscribed to
1808	freebsd-current@freebsd.org.  Make sure that before you update
1809	your sources that you have read and understood all the recent
1810	messages there.  If in doubt, please track -stable which has
1811	much fewer pitfalls.
1812
1813	[1] If you have third party modules, such as vmware, you
1814	should disable them at this point so they don't crash your
1815	system on reboot.
1816
1817	[3] From the bootblocks, boot -s, and then do
1818		fsck -p
1819		mount -u /
1820		mount -a
1821		cd src
1822		adjkerntz -i		# if CMOS is wall time
1823	Also, when doing a major release upgrade, it is required that
1824	you boot into single user mode to do the installworld.
1825
1826	[4] Note: This step is non-optional.  Failure to do this step
1827	can result in a significant reduction in the functionality of the
1828	system.  Attempting to do it by hand is not recommended and those
1829	that pursue this avenue should read this file carefully, as well
1830	as the archives of freebsd-current and freebsd-hackers mailing lists
1831	for potential gotchas.  The -U option is also useful to consider.
1832	See mergemaster(8) for more information.
1833
1834	[5] Usually this step is a no-op.  However, from time to time
1835	you may need to do this if you get unknown user in the following
1836	step.  It never hurts to do it all the time.  You may need to
1837	install a new mergemaster (cd src/usr.sbin/mergemaster && make
1838	install) after the buildworld before this step if you last updated
1839	from current before 20130425 or from -stable before 20130430.
1840
1841	[6] This only deletes old files and directories. Old libraries
1842	can be deleted by "make delete-old-libs", but you have to make
1843	sure that no program is using those libraries anymore.
1844
1845	[8] In order to have a kernel that can run the 4.x binaries needed to
1846	do an installworld, you must include the COMPAT_FREEBSD4 option in
1847	your kernel.  Failure to do so may leave you with a system that is
1848	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1849	required to run the 5.x binaries on more recent kernels.  And so on
1850	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1851
1852	Make sure that you merge any new devices from GENERIC since the
1853	last time you updated your kernel config file.
1854
1855	[9] If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1856	"?=" instead of the "=" assignment operator, so that buildworld can
1857	override the CPUTYPE if it needs to.
1858
1859	MAKEOBJDIRPREFIX must be defined in an environment variable, and
1860	not on the command line, or in /etc/make.conf.  buildworld will
1861	warn if it is improperly defined.
1862FORMAT:
1863
1864This file contains a list, in reverse chronological order, of major
1865breakages in tracking -current.  It is not guaranteed to be a complete
1866list of such breakages, and only contains entries since September 23, 2011.
1867If you need to see UPDATING entries from before that date, you will need
1868to fetch an UPDATING file from an older FreeBSD release.
1869
1870Copyright information:
1871
1872Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1873
1874Redistribution, publication, translation and use, with or without
1875modification, in full or in part, in any form or format of this
1876document are permitted without further permission from the author.
1877
1878THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1879IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1880WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1881DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1882INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1883(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1884SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1885HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1886STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1887IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1888POSSIBILITY OF SUCH DAMAGE.
1889
1890Contact Warner Losh if you have any questions about your use of
1891this document.
1892
1893$FreeBSD$
1894