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