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