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