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