xref: /freebsd/UPDATING (revision e08e9e999091f86081377b7cedc3fd2fe2ab70fc)
1Updating 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/current-stable.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 12.x IS SLOW:
20	FreeBSD 12.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
34
35****************************** SPECIAL WARNING: ******************************
36
37	Due to a bug in some versions of clang that's very hard to workaround in
38	the upgrade process, to upgrade to -current you must first upgrade
39	either stable/9 after r286035 or stable/10 after r286033 (including
40	10.3-RELEASE) or current after r286007 (including stable/11 and
41	11.0-RELEASE). These revisions post-date the 10.2 and 9.3 releases, so
42	you'll need to take the unusual step of upgrading to the tip of the
43	stable branch before moving to 11 or -current via a source upgrade.
44	stable/11 and 11.0-RELEASE have working newer compiler. This differs
45	from the historical situation where one could upgrade from anywhere on
46	the last couple of stable branches, so be careful.
47
48	If you're running a hybrid system on 9.x or 10.x with an updated clang
49	compiler or are using an supported external toolchain, the build system
50	will allow the upgrade. Otherwise it will print a reminder.
51
52****************************** SPECIAL WARNING: ******************************
53
5420180523:
55	The on-disk format for hwpmc callchain records has changed to include
56	threadid corresponding to a given record. This changes the field offsets
57	and thus requires that libpmcstat be rebuilt before using a kernel
58	later than r334108.
59
6020180517:
61	The vxge(4) driver has been removed.  This driver was introduced into
62	HEAD one week before the Exar left the Ethernet market and is not
63	known to be used.  If you have device vxge in your kernel config file
64	it must be removed.
65
6620180510:
67	The amd64 kernel now requires a ld that supports ifunc to produce a
68	working kernel, either lld or a newer binutils. lld is built by default
69	on amd64, and the 'buildkernel' target uses it automatically. However,
70	it is not the default linker, so building the kernel the traditional
71	way requires LD=ld.lld on the command line (or LD=/usr/local/bin/ld for
72	binutils port/package). lld will soon be default, and this requirement
73	will go away.
74
7520180508:
76	The nxge(4) driver has been removed.  This driver was for PCI-X 10g
77	cards made by s2io/Neterion.  The company was aquired by Exar and
78	no longer sells or supports Ethernet products.  If you have device
79	nxge in your kernel config file it must be removed.
80
8120180504:
82	The tz database (tzdb) has been updated to 2018e.  This version more
83	correctly models time stamps in time zones with negative DST such as
84	Europe/Dublin (from 1971 on), Europe/Prague (1946/7), and
85	Africa/Windhoek (1994/2017).  This does not affect the UT offsets, only
86	time zone abbreviations and the tm_isdst flag.
87
8820180502:
89	The ixgb(4) driver has been removed.  This driver was for an early and
90	uncommon legacy PCI 10GbE for a single ASIC, Intel 82597EX. Intel
91	quickly shifted to the long lived ixgbe family.  If you have device
92	ixgb in your kernel config file it must be removed.
93
9420180501:
95	The lmc(4) driver has been removed.  This was a WAN interface
96	card that was already reportedly rare in 2003, and had an ambiguous
97	license.  If you have device lmc in your kernel config file it must
98	be removed.
99
10020180413:
101	Support for Arcnet networks has been removed.  If you have device
102	arcnet or device cm in your kernel config file they must be
103	removed.
104
10520180411:
106	Support for FDDI networks has been removed.  If you have device
107	fddi or device fpa in your kernel config file they must be
108	removed.
109
11020180406:
111	In addition to supporting RFC 3164 formatted messages, the
112	syslogd(8) service is now capable of parsing RFC 5424 formatted
113	log messages. The main benefit of using RFC 5424 is that clients
114	may now send log messages with timestamps containing year numbers,
115	microseconds and time zone offsets.
116
117	Similarly, the syslog(3) C library function has been altered to
118	send RFC 5424 formatted messages to the local system logging
119	daemon. On systems using syslogd(8), this change should have no
120	negative impact, as long as syslogd(8) and the C library are
121	updated at the same time. On systems using a different system
122	logging daemon, it may be necessary to make configuration
123	adjustments, depending on the software used.
124
125	When using syslog-ng, add the 'syslog-protocol' flag to local
126	input sources to enable parsing of RFC 5424 formatted messages:
127
128		source src {
129			unix-dgram("/var/run/log" flags(syslog-protocol));
130		}
131
132	When using rsyslog, disable the 'SysSock.UseSpecialParser' option
133	of the 'imuxsock' module to let messages be processed by the
134	regular RFC 3164/5424 parsing pipeline:
135
136		module(load="imuxsock" SysSock.UseSpecialParser="off")
137
138	Do note that these changes only affect communication between local
139	applications and syslogd(8). The format that syslogd(8) uses to
140	store messages on disk or forward messages to other systems
141	remains unchanged. syslogd(8) still uses RFC 3164 for these
142	purposes. Options to customize this behaviour will be added in the
143	future. Utilities that process log files stored in /var/log are
144	thus expected to continue to function as before.
145
146	__FreeBSD_version has been incremented to 1200061 to denote this
147	change.
148
14920180328:
150	Support for token ring networks has been removed. If you
151	have "device token" in your kernel config you should remove
152	it. No device drivers supported token ring.
153
15420180323:
155	makefs was modified to be able to tag ISO9660 El Torito boot catalog
156	entries as EFI instead of overloading the i386 tag as done previously.
157	The amd64 mkisoimages.sh script used to build amd64 ISO images for
158	release was updated to use this. This may mean that makefs must be
159	updated before "make cdrom" can be run in the release directory. This
160	should be as simple as:
161
162		$ cd $SRCDIR/usr.sbin/makefs
163		$ make depend all install
164
16520180212:
166	FreeBSD boot loader enhanced with Lua scripting. It's purely opt-in for
167	now by building WITH_LOADER_LUA and WITHOUT_FORTH in /etc/src.conf.
168	Co-existance for the transition period will come shortly. Booting is a
169	complex environment and test coverage for Lua-enabled loaders has been
170	thin, so it would be prudent to assume it might not work and make
171	provisions for backup boot methods.
172
17320180211:
174	devmatch functionality has been turned on in devd. It will automatically
175	load drivers for unattached devices. This may cause unexpected drivers to
176	be loaded. Please report any problems to current@ and imp@freebsd.org.
177
17820180114:
179	Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
180	6.0.0.  Please see the 20141231 entry below for information about
181	prerequisites and upgrading, if you are not already using clang 3.5.0
182	or higher.
183
18420180110:
185	LLVM's lld linker is now used as the FreeBSD/amd64 bootstrap linker.
186	This means it is used to link the kernel and userland libraries and
187	executables, but is not yet installed as /usr/bin/ld by default.
188
189	To revert to ld.bfd as the bootstrap linker, in /etc/src.conf set
190        WITHOUT_LLD_BOOTSTRAP=yes
191
19220180110:
193	On i386, pmtimer has been removed. Its functionality has been folded
194	into apm. It was a no-op on ACPI in current for a while now (but was still
195	needed on i386 in FreeBSD 11 and earlier). Users may need to remove it
196	from kernel config files.
197
19820180104:
199	The use of RSS hash from the network card aka flowid has been
200	disabled by default for lagg(4) as it's currently incompatible with
201	the lacp and loadbalance protocols.
202
203	This can be re-enabled by setting the following in loader.conf:
204	net.link.lagg.default_use_flowid="1"
205
20620180102:
207	The SW_WATCHDOG option is no longer necessary to enable the
208	hardclock-based software watchdog if no hardware watchdog is
209	configured. As before, SW_WATCHDOG will cause the software
210	watchdog to be enabled even if a hardware watchdog is configured.
211
21220171215:
213	r326887 fixes the issue described in the 20171214 UPDATING entry.
214	r326888 flips the switch back to building GELI support always.
215
21620171214:
217	r362593 broke ZFS + GELI support for reasons unknown. However,
218	it also broke ZFS support generally, so GELI has been turned off
219	by default as the lesser evil in r326857. If you boot off ZFS and/or
220	GELI, it might not be a good time to update.
221
22220171125:
223	PowerPC users must update loader(8) by rebuilding world before
224	installing a new kernel, as the protocol connecting them has
225	changed. Without the update, loader metadata will not be passed
226	successfully to the kernel and users will have to enter their
227	root partition at the kernel mountroot prompt to continue booting.
228	Newer versions of loader can boot old kernels without issue.
229
23020171110:
231	The LOADER_FIREWIRE_SUPPORT build variable as been renamed to
232	WITH/OUT_LOADER_FIREWIRE. LOADER_{NO_,}GELI_SUPPORT has been renamed
233	to WITH/OUT_LOADER_GELI.
234
23520171106:
236	The naive and non-compliant support of posix_fallocate(2) in ZFS
237	has been removed as of r325320.  The system call now returns EINVAL
238	when used on a ZFS file.  Although the new behavior complies with the
239	standard, some consumers are not prepared to cope with it.
240	One known victim is lld prior to r325420.
241
24220171102:
243	Building in a FreeBSD src checkout will automatically create object
244	directories now rather than store files in the current directory if
245	'make obj' was not ran.  Calling 'make obj' is no longer necessary.
246	This feature can be disabled by setting WITHOUT_AUTO_OBJ=yes in
247	/etc/src-env.conf (not /etc/src.conf), or passing the option in the
248	environment.
249
25020171101:
251	The default MAKEOBJDIR has changed from /usr/obj/<srcdir> for native
252	builds, and /usr/obj/<arch>/<srcdir> for cross-builds, to a unified
253	/usr/obj/<srcdir>/<arch>.  This behavior can be changed to the old
254	format by setting WITHOUT_UNIFIED_OBJDIR=yes in /etc/src-env.conf,
255	the environment, or with -DWITHOUT_UNIFIED_OBJDIR when building.
256	The UNIFIED_OBJDIR option is a transitional feature that will be
257	removed for 12.0 release; please migrate to the new format for any
258	tools by looking up the OBJDIR used by 'make -V .OBJDIR' means rather
259	than hardcoding paths.
260
26120171028:
262	The native-xtools target no longer installs the files by default to the
263	OBJDIR.  Use the native-xtools-install target with a DESTDIR to install
264	to ${DESTDIR}/${NXTP} where NXTP defaults to /nxb-bin.
265
26620171021:
267	As part of the boot loader infrastructure cleanup, LOADER_*_SUPPORT
268	options are changing from controlling the build if defined / undefined
269	to controlling the build with explicit 'yes' or 'no' values. They will
270	shift to WITH/WITHOUT options to match other options in the system.
271
27220171010:
273	libstand has turned into a private library for sys/boot use only.
274	It is no longer supported as a public interface outside of sys/boot.
275
27620171005:
277	The arm port has split armv6 into armv6 and armv7. armv7 is now
278	a valid TARGET_ARCH/MACHINE_ARCH setting. If you have an armv7 system
279	and are running a kernel from before r324363, you will need to add
280	MACHINE_ARCH=armv7 to 'make buildworld' to do a native build.
281
28220171003:
283	When building multiple kernels using KERNCONF, non-existent KERNCONF
284	files will produce an error and buildkernel will fail. Previously
285	missing KERNCONF files silently failed giving no indication as to
286	why, only to subsequently discover during installkernel that the
287	desired kernel was never built in the first place.
288
28920170912:
290	The default serial number format for CTL LUNs has changed.  This will
291	affect users who use /dev/diskid/* device nodes, or whose FibreChannel
292	or iSCSI clients care about their LUNs' serial numbers.  Users who
293	require serial number stability should hardcode serial numbers in
294	/etc/ctl.conf .
295
29620170912:
297	For 32-bit arm compiled for hard-float support, soft-floating point
298	binaries now always get their shared libraries from
299	LD_SOFT_LIBRARY_PATH (in the past, this was only used if
300	/usr/libsoft also existed). Only users with a hard-float ld.so, but
301	soft-float everything else should be affected.
302
30320170826:
304	The geli password typed at boot is now hidden.  To restore the previous
305	behavior, see geli(8) for configuration options.
306
30720170825:
308	Move PMTUD blackhole counters to TCPSTATS and remove them from bare
309	sysctl values.  Minor nit, but requires a rebuild of both world/kernel
310	to complete.
311
31220170814:
313	"make check" behavior (made in ^/head@r295380) has been changed to
314	execute from a limited sandbox, as opposed to executing from
315	${TESTSDIR}.
316
317	Behavioral changes:
318	- The "beforecheck" and "aftercheck" targets are now specified.
319	- ${CHECKDIR} (added in commit noted above) has been removed.
320	- Legacy behavior can be enabled by setting
321	  WITHOUT_MAKE_CHECK_USE_SANDBOX in src.conf(5) or the environment.
322
323	If the limited sandbox mode is enabled, "make check" will execute
324	"make distribution", then install, execute the tests, and clean up the
325	sandbox if successful.
326
327	The "make distribution" and "make install" targets are typically run as
328	root to set appropriate permissions and ownership at installation time.
329	The end-user should set "WITH_INSTALL_AS_USER" in src.conf(5) or the
330	environment if executing "make check" with limited sandbox mode using
331	an unprivileged user.
332
33320170808:
334	Since the switch to GPT disk labels, fsck for UFS/FFS has been
335	unable to automatically find alternate superblocks. As of r322297,
336	the information needed to find alternate superblocks has been
337	moved to the end of the area reserved for the boot block.
338	Filesystems created with a newfs of this vintage or later
339	will create the recovery information. If you have a filesystem
340	created prior to this change and wish to have a recovery block
341	created for your filesystem, you can do so by running fsck in
342	foreground mode (i.e., do not use the -p or -y options). As it
343	starts, fsck will ask ``SAVE DATA TO FIND ALTERNATE SUPERBLOCKS''
344	to which you should answer yes.
345
34620170728:
347	As of r321665, an NFSv4 server configuration that services
348	Kerberos mounts or clients that do not support the uid/gid in
349	owner/owner_group string capability, must explicitly enable
350	the nfsuserd daemon by adding nfsuserd_enable="YES" to the
351	machine's /etc/rc.conf file.
352
35320170722:
354	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 5.0.0.
355	Please see the 20141231 entry below for information about prerequisites
356	and upgrading, if you are not already using clang 3.5.0 or higher.
357
35820170701:
359	WITHOUT_RCMDS is now the default. Set WITH_RCMDS if you need the
360	r-commands (rlogin, rsh, etc.) to be built with the base system.
361
36220170625:
363	The FreeBSD/powerpc platform now uses a 64-bit type for time_t.  This is
364	a very major ABI incompatible change, so users of FreeBSD/powerpc must
365	be careful when performing source upgrades.  It is best to run
366	'make installworld' from an alternate root system, either a live
367	CD/memory stick, or a temporary root partition.  Additionally, all ports
368	must be recompiled.  powerpc64 is largely unaffected, except in the case
369	of 32-bit compatibility.  All 32-bit binaries will be affected.
370
37120170623:
372	Forward compatibility for the "ino64" project have been committed. This
373	will allow most new binaries to run on older kernels in a limited
374	fashion.  This prevents many of the common foot-shooting actions in the
375	upgrade as well as the limited ability to roll back the kernel across
376	the ino64 upgrade. Complicated use cases may not work properly, though
377	enough simpler ones work to allow recovery in most situations.
378
37920170620:
380	Switch back to the BSDL dtc (Device Tree Compiler). Set WITH_GPL_DTC
381	if you require the GPL compiler.
382
38320170618:
384	The internal ABI used for communication between the NFS kernel modules
385	was changed by r320085, so __FreeBSD_version was bumped to
386	ensure all the NFS related modules are updated together.
387
38820170617:
389	The ABI of struct event was changed by extending the data
390	member to 64bit and adding ext fields.  For upgrade, same
391	precautions as for the entry 20170523 "ino64" must be
392	followed.
393
39420170531:
395	The GNU roff toolchain has been removed from base. To render manpages
396	which are not supported by mandoc(1), man(1) can fallback on GNU roff
397	from ports (and recommends to install it).
398	To render roff(7) documents, consider using GNU roff from ports or the
399	heirloom doctools roff toolchain from ports via pkg install groff or
400	via pkg install heirloom-doctools.
401
40220170524:
403	The ath(4) and ath_hal(4) modules now build piecemeal to allow for
404	smaller runtime footprint builds.  This is useful for embedded systems
405	which only require one chipset support.
406
407	If you load it as a module, make sure this is in /boot/loader.conf:
408
409	if_ath_load="YES"
410
411	This will load the HAL, all chip/RF backends and if_ath_pci.
412	If you have if_ath_pci in /boot/loader.conf, ensure it is after
413	if_ath or it will not load any HAL chipset support.
414
415	If you want to selectively load things (eg on ye cheape ARM/MIPS
416	platforms where RAM is at a premium) you should:
417
418	* load ath_hal
419	* load the chip modules in question
420	* load ath_rate, ath_dfs
421	* load ath_main
422	* load if_ath_pci and/or if_ath_ahb depending upon your particular
423	  bus bind type - this is where probe/attach is done.
424
425	For further comments/feedback, poke adrian@ .
426
42720170523:
428	The "ino64" 64-bit inode project has been committed, which extends
429	a number of types to 64 bits.  Upgrading in place requires care and
430	adherence to the documented upgrade procedure.
431
432	If using a custom kernel configuration ensure that the
433	COMPAT_FREEBSD11 option is included (as during the upgrade the
434	system will be running the ino64 kernel with the existing world).
435
436	For the safest in-place upgrade begin by removing previous build
437	artifacts via "rm -rf /usr/obj/*".   Then, carefully follow the
438	full procedure documented below under the heading "To rebuild
439	everything and install it on the current system."  Specifically,
440	a reboot is required after installing the new kernel before
441	installing world.
442
44320170424:
444	The NATM framework including the en(4), fatm(4), hatm(4), and
445	patm(4) devices has been removed.  Consumers should plan a
446	migration before the end-of-life date for FreeBSD 11.
447
44820170420:
449	GNU diff has been replaced by a BSD licensed diff. Some features of GNU
450	diff has not been implemented, if those are needed a newer version of
451	GNU diff is available via the diffutils package under the gdiff name.
452
45320170413:
454	As of r316810 for ipfilter, keep frags is no longer assumed when
455	keep state is specified in a rule. r316810 aligns ipfilter with
456	documentation in man pages separating keep frags from keep state.
457	This allows keep state to be specified without forcing keep frags
458	and allows keep frags to be specified independently of keep state.
459	To maintain previous behaviour, also specify keep frags with
460	keep state (as documented in ipf.conf.5).
461
46220170407:
463	arm64 builds now use the base system LLD 4.0.0 linker by default,
464	instead of requiring that the aarch64-binutils port or package be
465	installed. To continue using aarch64-binutils, set
466	CROSS_BINUTILS_PREFIX=/usr/local/aarch64-freebsd/bin .
467
46820170405:
469	The UDP optimization in entry 20160818 that added the sysctl
470	net.inet.udp.require_l2_bcast has been reverted.  L2 broadcast
471	packets will no longer be treated as L3 broadcast packets.
472
47320170331:
474	Binds and sends to the loopback addresses, IPv6 and IPv4, will now
475	use any explicitly assigned loopback address available in the jail
476	instead of using the first assigned address of the jail.
477
47820170329:
479	The ctl.ko module no longer implements the iSCSI target frontend:
480	cfiscsi.ko does instead.
481
482	If building cfiscsi.ko as a kernel module, the module can be loaded
483	via one of the following methods:
484	- `cfiscsi_load="YES"` in loader.conf(5).
485	- Add `cfiscsi` to `$kld_list` in rc.conf(5).
486	- ctladm(8)/ctld(8), when compiled with iSCSI support
487	  (`WITH_ISCSI=yes` in src.conf(5))
488
489	Please see cfiscsi(4) for more details.
490
49120170316:
492	The mmcsd.ko module now additionally depends on geom_flashmap.ko.
493	Also, mmc.ko and mmcsd.ko need to be a matching pair built from the
494	same source (previously, the dependency of mmcsd.ko on mmc.ko was
495	missing, but mmcsd.ko now will refuse to load if it is incompatible
496	with mmc.ko).
497
49820170315:
499	The syntax of ipfw(8) named states was changed to avoid ambiguity.
500	If you have used named states in the firewall rules, you need to modify
501	them after installworld and before rebooting. Now named states must
502	be prefixed with colon.
503
50420170311:
505	The old drm (sys/dev/drm/) drivers for i915 and radeon have been
506	removed as the userland we provide cannot use them. The KMS version
507	(sys/dev/drm2) supports the same hardware.
508
50920170302:
510	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 4.0.0.
511	Please see the 20141231 entry below for information about prerequisites
512	and upgrading, if you are not already using clang 3.5.0 or higher.
513
51420170221:
515	The code that provides support for ZFS .zfs/ directory functionality
516	has been reimplemented.  It's not possible now to create a snapshot
517	by mkdir under .zfs/snapshot/.  That should be the only user visible
518	change.
519
52020170216:
521	EISA bus support has been removed. The WITH_EISA option is no longer
522	valid.
523
52420170215:
525	MCA bus support has been removed.
526
52720170127:
528	The WITH_LLD_AS_LD / WITHOUT_LLD_AS_LD build knobs have been renamed
529	WITH_LLD_IS_LD / WITHOUT_LLD_IS_LD, for consistency with CLANG_IS_CC.
530
53120170112:
532	The EM_MULTIQUEUE kernel configuration option is deprecated now that
533	the em(4) driver conforms to iflib specifications.
534
53520170109:
536	The igb(4), em(4) and lem(4) ethernet drivers are now implemented via
537	IFLIB.  If you have a custom kernel configuration that excludes em(4)
538	but you use igb(4), you need to re-add em(4) to your custom configuration.
539
54020161217:
541	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.1.
542	Please see the 20141231 entry below for information about prerequisites
543	and upgrading, if you are not already using clang 3.5.0 or higher.
544
54520161124:
546	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.0.
547	Please see the 20141231 entry below for information about prerequisites
548	and upgrading, if you are not already using clang 3.5.0 or higher.
549
55020161119:
551	The layout of the pmap structure has changed for powerpc to put the pmap
552	statistics at the front for all CPU variations.  libkvm(3) and all tools
553	that link against it need to be recompiled.
554
55520161030:
556	isl(4) and cyapa(4) drivers now require a new driver,
557	chromebook_platform(4), to work properly on Chromebook-class hardware.
558	On other types of hardware the drivers may need to be configured using
559	device hints.  Please see the corresponding manual pages for details.
560
56120161017:
562	The urtwn(4) driver was merged into rtwn(4) and now consists of
563	rtwn(4) main module + rtwn_usb(4) and rtwn_pci(4) bus-specific
564	parts.
565	Also, firmware for RTL8188CE was renamed due to possible name
566	conflict (rtwnrtl8192cU(B) -> rtwnrtl8192cE(B))
567
56820161015:
569	GNU rcs has been removed from base.  It is available as packages:
570	- rcs: Latest GPLv3 GNU rcs version.
571	- rcs57: Copy of the latest version of GNU rcs (GPLv2) before it was
572	removed from base.
573
57420161008:
575	Use of the cc_cdg, cc_chd, cc_hd, or cc_vegas congestion control
576	modules now requires that the kernel configuration contain the
577	TCP_HHOOK option. (This option is included in the GENERIC kernel.)
578
57920161003:
580	The WITHOUT_ELFCOPY_AS_OBJCOPY src.conf(5) knob has been retired.
581	ELF Tool Chain's elfcopy is always installed as /usr/bin/objcopy.
582
58320160924:
584	Relocatable object files with the extension of .So have been renamed
585	to use an extension of .pico instead.  The purpose of this change is
586	to avoid a name clash with shared libraries on case-insensitive file
587	systems.  On those file systems, foo.So is the same file as foo.so.
588
58920160918:
590	GNU rcs has been turned off by default.  It can (temporarily) be built
591	again by adding WITH_RCS knob in src.conf.
592	Otherwise, GNU rcs is available from packages:
593	- rcs: Latest GPLv3 GNU rcs version.
594	- rcs57: Copy of the latest version of GNU rcs (GPLv2) from base.
595
59620160918:
597	The backup_uses_rcs functionality has been removed from rc.subr.
598
59920160908:
600	The queue(3) debugging macro, QUEUE_MACRO_DEBUG, has been split into
601	two separate components, QUEUE_MACRO_DEBUG_TRACE and
602	QUEUE_MACRO_DEBUG_TRASH.  Define both for the original
603	QUEUE_MACRO_DEBUG behavior.
604
60520160824:
606	r304787 changed some ioctl interfaces between the iSCSI userspace
607	programs and the kernel.  ctladm, ctld, iscsictl, and iscsid must be
608	rebuilt to work with new kernels.  __FreeBSD_version has been bumped
609	to 1200005.
610
61120160818:
612	The UDP receive code has been updated to only treat incoming UDP
613	packets that were addressed to an L2 broadcast address as L3
614	broadcast packets.  It is not expected that this will affect any
615	standards-conforming UDP application.  The new behaviour can be
616	disabled by setting the sysctl net.inet.udp.require_l2_bcast to
617	0.
618
61920160818:
620	Remove the openbsd_poll system call.
621	__FreeBSD_version has been bumped because of this.
622
62320160622:
624	The libc stub for the pipe(2) system call has been replaced with
625	a wrapper that calls the pipe2(2) system call and the pipe(2)
626	system call is now only implemented by the kernels that include
627	"options COMPAT_FREEBSD10" in their config file (this is the
628	default).  Users should ensure that this option is enabled in
629	their kernel or upgrade userspace to r302092 before upgrading their
630	kernel.
631
63220160527:
633	CAM will now strip leading spaces from SCSI disks' serial numbers.
634	This will affect users who create UFS filesystems on SCSI disks using
635	those disk's diskid device nodes.  For example, if /etc/fstab
636	previously contained a line like
637	"/dev/diskid/DISK-%20%20%20%20%20%20%20ABCDEFG0123456", you should
638	change it to "/dev/diskid/DISK-ABCDEFG0123456".  Users of geom
639	transforms like gmirror may also be affected.  ZFS users should
640	generally be fine.
641
64220160523:
643	The bitstring(3) API has been updated with new functionality and
644	improved performance.  But it is binary-incompatible with the old API.
645	Objects built with the new headers may not be linked against objects
646	built with the old headers.
647
64820160520:
649	The brk and sbrk functions have been removed from libc on arm64.
650	Binutils from ports has been updated to not link to these
651	functions and should be updated to the latest version before
652	installing a new libc.
653
65420160517:
655	The armv6 port now defaults to hard float ABI. Limited support
656	for running both hardfloat and soft float on the same system
657	is available using the libraries installed with -DWITH_LIBSOFT.
658	This has only been tested as an upgrade path for installworld
659	and packages may fail or need manual intervention to run. New
660	packages will be needed.
661
662	To update an existing self-hosted armv6hf system, you must add
663	TARGET_ARCH=armv6 on the make command line for both the build
664	and the install steps.
665
66620160510:
667	Kernel modules compiled outside of a kernel build now default to
668	installing to /boot/modules instead of /boot/kernel.  Many kernel
669	modules built this way (such as those in ports) already overrode
670	KMODDIR explicitly to install into /boot/modules.  However,
671	manually building and installing a module from /sys/modules will
672	now install to /boot/modules instead of /boot/kernel.
673
67420160414:
675	The CAM I/O scheduler has been committed to the kernel. There should be
676	no user visible impact. This does enable NCQ Trim on ada SSDs. While the
677	list of known rogues that claim support for this but actually corrupt
678	data is believed to be complete, be on the lookout for data
679	corruption. The known rogue list is believed to be complete:
680
681		o Crucial MX100, M550 drives with MU01 firmware.
682		o Micron M510 and M550 drives with MU01 firmware.
683		o Micron M500 prior to MU07 firmware
684		o Samsung 830, 840, and 850 all firmwares
685		o FCCT M500 all firmwares
686
687	Crucial has firmware http://www.crucial.com/usa/en/support-ssd-firmware
688	with working NCQ TRIM. For Micron branded drives, see your sales rep for
689	updated firmware. Black listed drives will work correctly because these
690	drives work correctly so long as no NCQ TRIMs are sent to them. Given
691	this list is the same as found in Linux, it's believed there are no
692	other rogues in the market place. All other models from the above
693	vendors work.
694
695	To be safe, if you are at all concerned, you can quirk each of your
696	drives to prevent NCQ from being sent by setting:
697		kern.cam.ada.X.quirks="0x2"
698	in loader.conf. If the drive requires the 4k sector quirk, set the
699	quirks entry to 0x3.
700
70120160330:
702	The FAST_DEPEND build option has been removed and its functionality is
703	now the one true way.  The old mkdep(1) style of 'make depend' has
704	been removed.  See 20160311 for further details.
705
70620160317:
707	Resource range types have grown from unsigned long to uintmax_t.  All
708	drivers, and anything using libdevinfo, need to be recompiled.
709
71020160311:
711	WITH_FAST_DEPEND is now enabled by default for in-tree and out-of-tree
712	builds.  It no longer runs mkdep(1) during 'make depend', and the
713	'make depend' stage can safely be skipped now as it is auto ran
714	when building 'make all' and will generate all SRCS and DPSRCS before
715	building anything else.  Dependencies are gathered at compile time with
716	-MF flags kept in separate .depend files per object file.  Users should
717	run 'make cleandepend' once if using -DNO_CLEAN to clean out older
718	stale .depend files.
719
72020160306:
721	On amd64, clang 3.8.0 can now insert sections of type AMD64_UNWIND into
722	kernel modules.  Therefore, if you load any kernel modules at boot time,
723	please install the boot loaders after you install the kernel, but before
724	rebooting, e.g.:
725
726	make buildworld
727	make buildkernel KERNCONF=YOUR_KERNEL_HERE
728	make installkernel KERNCONF=YOUR_KERNEL_HERE
729	make -C sys/boot install
730	<reboot in single user>
731
732	Then follow the usual steps, described in the General Notes section,
733	below.
734
73520160305:
736	Clang, llvm, lldb and compiler-rt have been upgraded to 3.8.0.  Please
737	see the 20141231 entry below for information about prerequisites and
738	upgrading, if you are not already using clang 3.5.0 or higher.
739
74020160301:
741	The AIO subsystem is now a standard part of the kernel.  The
742	VFS_AIO kernel option and aio.ko kernel module have been removed.
743	Due to stability concerns, asynchronous I/O requests are only
744	permitted on sockets and raw disks by default.  To enable
745	asynchronous I/O requests on all file types, set the
746	vfs.aio.enable_unsafe sysctl to a non-zero value.
747
74820160226:
749	The ELF object manipulation tool objcopy is now provided by the
750	ELF Tool Chain project rather than by GNU binutils. It should be a
751	drop-in replacement, with the addition of arm64 support. The
752	(temporary) src.conf knob WITHOUT_ELFCOPY_AS_OBJCOPY knob may be set
753	to obtain the GNU version if necessary.
754
75520160129:
756	Building ZFS pools on top of zvols is prohibited by default.  That
757	feature has never worked safely; it's always been prone to deadlocks.
758	Using a zvol as the backing store for a VM guest's virtual disk will
759	still work, even if the guest is using ZFS.  Legacy behavior can be
760	restored by setting vfs.zfs.vol.recursive=1.
761
76220160119:
763	The NONE and HPN patches has been removed from OpenSSH.  They are
764	still available in the security/openssh-portable port.
765
76620160113:
767	With the addition of ypldap(8), a new _ypldap user is now required
768	during installworld. "mergemaster -p" can be used to add the user
769	prior to installworld, as documented in the handbook.
770
77120151216:
772	The tftp loader (pxeboot) now uses the option root-path directive. As a
773	consequence it no longer looks for a pxeboot.4th file on the tftp
774	server. Instead it uses the regular /boot infrastructure as with the
775	other loaders.
776
77720151211:
778	The code to start recording plug and play data into the modules has
779	been committed. While the old tools will properly build a new kernel,
780	a number of warnings about "unknown metadata record 4" will be produced
781	for an older kldxref. To avoid such warnings, make sure to rebuild
782	the kernel toolchain (or world). Make sure that you have r292078 or
783	later when trying to build 292077 or later before rebuilding.
784
78520151207:
786	Debug data files are now built by default with 'make buildworld' and
787	installed with 'make installworld'. This facilitates debugging but
788	requires more disk space both during the build and for the installed
789	world. Debug files may be disabled by setting WITHOUT_DEBUG_FILES=yes
790	in src.conf(5).
791
79220151130:
793	r291527 changed the internal interface between the nfsd.ko and
794	nfscommon.ko modules. As such, they must both be upgraded to-gether.
795	__FreeBSD_version has been bumped because of this.
796
79720151108:
798	Add support for unicode collation strings leads to a change of
799	order of files listed by ls(1) for example. To get back to the old
800	behaviour, set LC_COLLATE environment variable to "C".
801
802	Databases administrators will need to reindex their databases given
803	collation results will be different.
804
805	Due to a bug in install(1) it is recommended to remove the ancient
806	locales before running make installworld.
807
808	rm -rf /usr/share/locale/*
809
81020151030:
811	The OpenSSL has been upgraded to 1.0.2d.  Any binaries requiring
812	libcrypto.so.7 or libssl.so.7 must be recompiled.
813
81420151020:
815	Qlogic 24xx/25xx firmware images were updated from 5.5.0 to 7.3.0.
816	Kernel modules isp_2400_multi and isp_2500_multi were removed and
817	should be replaced with isp_2400 and isp_2500 modules respectively.
818
81920151017:
820	The build previously allowed using 'make -n' to not recurse into
821	sub-directories while showing what commands would be executed, and
822	'make -n -n' to recursively show commands.  Now 'make -n' will recurse
823	and 'make -N' will not.
824
82520151012:
826	If you specify SENDMAIL_MC or SENDMAIL_CF in make.conf, mergemaster
827	and etcupdate will now use this file. A custom sendmail.cf is now
828	updated via this mechanism rather than via installworld.  If you had
829	excluded sendmail.cf in mergemaster.rc or etcupdate.conf, you may
830	want to remove the exclusion or change it to "always install".
831	/etc/mail/sendmail.cf is now managed the same way regardless of
832	whether SENDMAIL_MC/SENDMAIL_CF is used.  If you are not using
833	SENDMAIL_MC/SENDMAIL_CF there should be no change in behavior.
834
83520151011:
836	Compatibility shims for legacy ATA device names have been removed.
837	It includes ATA_STATIC_ID kernel option, kern.cam.ada.legacy_aliases
838	and kern.geom.raid.legacy_aliases loader tunables, kern.devalias.*
839	environment variables, /dev/ad* and /dev/ar* symbolic links.
840
84120151006:
842	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.7.0.
843	Please see the 20141231 entry below for information about prerequisites
844	and upgrading, if you are not already using clang 3.5.0 or higher.
845
84620150924:
847	Kernel debug files have been moved to /usr/lib/debug/boot/kernel/,
848	and renamed from .symbols to .debug. This reduces the size requirements
849	on the boot partition or file system and provides consistency with
850	userland debug files.
851
852	When using the supported kernel installation method the
853	/usr/lib/debug/boot/kernel directory will be renamed (to kernel.old)
854	as is done with /boot/kernel.
855
856	Developers wishing to maintain the historical behavior of installing
857	debug files in /boot/kernel/ can set KERN_DEBUGDIR="" in src.conf(5).
858
85920150827:
860	The wireless drivers had undergone changes that remove the 'parent
861	interface' from the ifconfig -l output. The rc.d network scripts
862	used to check presence of a parent interface in the list, so old
863	scripts would fail to start wireless networking. Thus, etcupdate(3)
864	or mergemaster(8) run is required after kernel update, to update your
865	rc.d scripts in /etc.
866
86720150827:
868	pf no longer supports 'scrub fragment crop' or 'scrub fragment drop-ovl'
869	These configurations are now automatically interpreted as
870	'scrub fragment reassemble'.
871
87220150817:
873	Kernel-loadable modules for the random(4) device are back. To use
874	them, the kernel must have
875
876	device	random
877	options	RANDOM_LOADABLE
878
879	kldload(8) can then be used to load random_fortuna.ko
880	or random_yarrow.ko. Please note that due to the indirect
881	function calls that the loadable modules need to provide,
882	the build-in variants will be slightly more efficient.
883
884	The random(4) kernel option RANDOM_DUMMY has been retired due to
885	unpopularity. It was not all that useful anyway.
886
88720150813:
888	The WITHOUT_ELFTOOLCHAIN_TOOLS src.conf(5) knob has been retired.
889	Control over building the ELF Tool Chain tools is now provided by
890	the WITHOUT_TOOLCHAIN knob.
891
89220150810:
893	The polarity of Pulse Per Second (PPS) capture events with the
894	uart(4) driver has been corrected.  Prior to this change the PPS
895	"assert" event corresponded to the trailing edge of a positive PPS
896	pulse and the "clear" event was the leading edge of the next pulse.
897
898	As the width of a PPS pulse in a typical GPS receiver is on the
899	order of 1 millisecond, most users will not notice any significant
900	difference with this change.
901
902	Anyone who has compensated for the historical polarity reversal by
903	configuring a negative offset equal to the pulse width will need to
904	remove that workaround.
905
90620150809:
907	The default group assigned to /dev/dri entries has been changed
908	from 'wheel' to 'video' with the id of '44'. If you want to have
909	access to the dri devices please add yourself to the video group
910	with:
911
912	# pw groupmod video -m $USER
913
91420150806:
915	The menu.rc and loader.rc files will now be replaced during
916	upgrades. Please migrate local changes to menu.rc.local and
917	loader.rc.local instead.
918
91920150805:
920	GNU Binutils versions of addr2line, c++filt, nm, readelf, size,
921	strings and strip have been removed. The src.conf(5) knob
922	WITHOUT_ELFTOOLCHAIN_TOOLS no longer provides the binutils tools.
923
92420150728:
925	As ZFS requires more kernel stack pages than is the default on some
926	architectures e.g. i386, it now warns if KSTACK_PAGES is less than
927	ZFS_MIN_KSTACK_PAGES (which is 4 at the time of writing).
928
929	Please consider using 'options KSTACK_PAGES=X' where X is greater
930	than or equal to ZFS_MIN_KSTACK_PAGES i.e. 4 in such configurations.
931
93220150706:
933	sendmail has been updated to 8.15.2.  Starting with FreeBSD 11.0
934	and sendmail 8.15, sendmail uses uncompressed IPv6 addresses by
935	default, i.e., they will not contain "::".  For example, instead
936	of ::1, it will be 0:0:0:0:0:0:0:1.  This permits a zero subnet
937	to have a more specific match, such as different map entries for
938	IPv6:0:0 vs IPv6:0.  This change requires that configuration
939	data (including maps, files, classes, custom ruleset, etc.) must
940	use the same format, so make certain such configuration data is
941	upgrading.  As a very simple check search for patterns like
942	'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'.  To return to the old
943	behavior, set the m4 option confUSE_COMPRESSED_IPV6_ADDRESSES or
944	the cf option UseCompressedIPv6Addresses.
945
94620150630:
947	The default kernel entropy-processing algorithm is now
948	Fortuna, replacing Yarrow.
949
950	Assuming you have 'device random' in your kernel config
951	file, the configurations allow a kernel option to override
952	this default. You may choose *ONE* of:
953
954	options	RANDOM_YARROW	# Legacy /dev/random algorithm.
955	options	RANDOM_DUMMY	# Blocking-only driver.
956
957	If you have neither, you get Fortuna.  For most people,
958	read no further, Fortuna will give a /dev/random that works
959	like it always used to, and the difference will be irrelevant.
960
961	If you remove 'device random', you get *NO* kernel-processed
962	entropy at all. This may be acceptable to folks building
963	embedded systems, but has complications. Carry on reading,
964	and it is assumed you know what you need.
965
966	*PLEASE* read random(4) and random(9) if you are in the
967	habit of tweaking kernel configs, and/or if you are a member
968	of the embedded community, wanting specific and not-usual
969	behaviour from your security subsystems.
970
971	NOTE!! If you use RANDOM_DUMMY and/or have no 'device
972	random', you will NOT have a functioning /dev/random, and
973	many cryptographic features will not work, including SSH.
974	You may also find strange behaviour from the random(3) set
975	of library functions, in particular sranddev(3), srandomdev(3)
976	and arc4random(3). The reason for this is that the KERN_ARND
977	sysctl only returns entropy if it thinks it has some to
978	share, and with RANDOM_DUMMY or no 'device random' this
979	will never happen.
980
98120150623:
982	An additional fix for the issue described in the 20150614 sendmail
983	entry below has been committed in revision 284717.
984
98520150616:
986	FreeBSD's old make (fmake) has been removed from the system. It is
987	available as the devel/fmake port or via pkg install fmake.
988
98920150615:
990	The fix for the issue described in the 20150614 sendmail entry
991	below has been committed in revision 284436.  The work
992	around described in that entry is no longer needed unless the
993	default setting is overridden by a confDH_PARAMETERS configuration
994	setting of '5' or pointing to a 512 bit DH parameter file.
995
99620150614:
997	ALLOW_DEPRECATED_ATF_TOOLS/ATFFILE support has been removed from
998	atf.test.mk (included from bsd.test.mk). Please upgrade devel/atf
999	and devel/kyua to version 0.20+ and adjust any calling code to work
1000	with Kyuafile and kyua.
1001
100220150614:
1003	The import of openssl to address the FreeBSD-SA-15:10.openssl
1004	security advisory includes a change which rejects handshakes
1005	with DH parameters below 768 bits.  sendmail releases prior
1006	to 8.15.2 (not yet released), defaulted to a 512 bit
1007	DH parameter setting for client connections.  To work around
1008	this interoperability, sendmail can be configured to use a
1009	2048 bit DH parameter by:
1010
1011	1. Edit /etc/mail/`hostname`.mc
1012	2. If a setting for confDH_PARAMETERS does not exist or
1013	   exists and is set to a string beginning with '5',
1014	   replace it with '2'.
1015	3. If a setting for confDH_PARAMETERS exists and is set to
1016	   a file path, create a new file with:
1017		openssl dhparam -out /path/to/file 2048
1018	4. Rebuild the .cf file:
1019		cd /etc/mail/; make; make install
1020	5. Restart sendmail:
1021		cd /etc/mail/; make restart
1022
1023	A sendmail patch is coming, at which time this file will be
1024	updated.
1025
102620150604:
1027	Generation of legacy formatted entries have been disabled by default
1028	in pwd_mkdb(8), as all base system consumers of the legacy formatted
1029	entries were converted to use the new format by default when the new,
1030	machine independent format have been added and supported since FreeBSD
1031	5.x.
1032
1033	Please see the pwd_mkdb(8) manual page for further details.
1034
103520150525:
1036	Clang and llvm have been upgraded to 3.6.1 release.  Please see the
1037	20141231 entry below for information about prerequisites and upgrading,
1038	if you are not already using 3.5.0 or higher.
1039
104020150521:
1041	TI platform code switched to using vendor DTS files and this update
1042	may break existing systems running on Beaglebone, Beaglebone Black,
1043	and Pandaboard:
1044
1045	- dtb files should be regenerated/reinstalled. Filenames are the
1046	  same but content is different now
1047	- GPIO addressing was changed, now each GPIO bank (32 pins per bank)
1048	  has its own /dev/gpiocX device, e.g. pin 121 on /dev/gpioc0 in old
1049	  addressing scheme is now pin 25 on /dev/gpioc3.
1050	- Pandaboard: /etc/ttys should be updated, serial console device is
1051	  now /dev/ttyu2, not /dev/ttyu0
1052
105320150501:
1054	soelim(1) from gnu/usr.bin/groff has been replaced by usr.bin/soelim.
1055	If you need the GNU extension from groff soelim(1), install groff
1056	from package: pkg install groff, or via ports: textproc/groff.
1057
105820150423:
1059	chmod, chflags, chown and chgrp now affect symlinks in -R mode as
1060	defined in symlink(7); previously symlinks were silently ignored.
1061
106220150415:
1063	The const qualifier has been removed from iconv(3) to comply with
1064	POSIX.  The ports tree is aware of this from r384038 onwards.
1065
106620150416:
1067	Libraries specified by LIBADD in Makefiles must have a corresponding
1068	DPADD_<lib> variable to ensure correct dependencies.  This is now
1069	enforced in src.libnames.mk.
1070
107120150324:
1072	From legacy ata(4) driver was removed support for SATA controllers
1073	supported by more functional drivers ahci(4), siis(4) and mvs(4).
1074	Kernel modules ataahci and ataadaptec were removed completely,
1075	replaced by ahci and mvs modules respectively.
1076
107720150315:
1078	Clang, llvm and lldb have been upgraded to 3.6.0 release.  Please see
1079	the 20141231 entry below for information about prerequisites and
1080	upgrading, if you are not already using 3.5.0 or higher.
1081
108220150307:
1083	The 32-bit PowerPC kernel has been changed to a position-independent
1084	executable. This can only be booted with a version of loader(8)
1085	newer than January 31, 2015, so make sure to update both world and
1086	kernel before rebooting.
1087
108820150217:
1089	If you are running a -CURRENT kernel since r273872 (Oct 30th, 2014),
1090	but before r278950, the RNG was not seeded properly.  Immediately
1091	upgrade the kernel to r278950 or later and regenerate any keys (e.g.
1092	ssh keys or openssl keys) that were generated w/ a kernel from that
1093	range.  This does not affect programs that directly used /dev/random
1094	or /dev/urandom.  All userland uses of arc4random(3) are affected.
1095
109620150210:
1097	The autofs(4) ABI was changed in order to restore binary compatibility
1098	with 10.1-RELEASE.  The automountd(8) daemon needs to be rebuilt to work
1099	with the new kernel.
1100
110120150131:
1102	The powerpc64 kernel has been changed to a position-independent
1103	executable. This can only be booted with a new version of loader(8),
1104	so make sure to update both world and kernel before rebooting.
1105
110620150118:
1107	Clang and llvm have been upgraded to 3.5.1 release.  This is a bugfix
1108	only release, no new features have been added.  Please see the 20141231
1109	entry below for information about prerequisites and upgrading, if you
1110	are not already using 3.5.0.
1111
111220150107:
1113	ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
1114	taken from the ELF Tool Chain project rather than GNU binutils. They
1115	should be drop-in replacements, with the addition of arm64 support.
1116	The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
1117	binutils tools, if necessary. See 20150805 for updated information.
1118
111920150105:
1120	The default Unbound configuration now enables remote control
1121	using a local socket.  Users who have already enabled the
1122	local_unbound service should regenerate their configuration
1123	by running "service local_unbound setup" as root.
1124
112520150102:
1126	The GNU texinfo and GNU info pages have been removed.
1127	To be able to view GNU info pages please install texinfo from ports.
1128
112920141231:
1130	Clang, llvm and lldb have been upgraded to 3.5.0 release.
1131
1132	As of this release, a prerequisite for building clang, llvm and lldb is
1133	a C++11 capable compiler and C++11 standard library.  This means that to
1134	be able to successfully build the cross-tools stage of buildworld, with
1135	clang as the bootstrap compiler, your system compiler or cross compiler
1136	should either be clang 3.3 or later, or gcc 4.8 or later, and your
1137	system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
1138	later.
1139
1140	On any standard FreeBSD 10.x or 11.x installation, where clang and
1141	libc++ are on by default (that is, on x86 or arm), this should work out
1142	of the box.
1143
1144	On 9.x installations where clang is enabled by default, e.g. on x86 and
1145	powerpc, libc++ will not be enabled by default, so libc++ should be
1146	built (with clang) and installed first.  If both clang and libc++ are
1147	missing, build clang first, then use it to build libc++.
1148
1149	On 8.x and earlier installations, upgrade to 9.x first, and then follow
1150	the instructions for 9.x above.
1151
1152	Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
1153	default, and do not build clang.
1154
1155	Many embedded systems are resource constrained, and will not be able to
1156	build clang in a reasonable time, or in some cases at all.  In those
1157	cases, cross building bootable systems on amd64 is a workaround.
1158
1159	This new version of clang introduces a number of new warnings, of which
1160	the following are most likely to appear:
1161
1162	-Wabsolute-value
1163
1164	This warns in two cases, for both C and C++:
1165	* When the code is trying to take the absolute value of an unsigned
1166	  quantity, which is effectively a no-op, and almost never what was
1167	  intended.  The code should be fixed, if at all possible.  If you are
1168	  sure that the unsigned quantity can be safely cast to signed, without
1169	  loss of information or undefined behavior, you can add an explicit
1170	  cast, or disable the warning.
1171
1172	* When the code is trying to take an absolute value, but the called
1173	  abs() variant is for the wrong type, which can lead to truncation.
1174	  If you want to disable the warning instead of fixing the code, please
1175	  make sure that truncation will not occur, or it might lead to unwanted
1176	  side-effects.
1177
1178	-Wtautological-undefined-compare and
1179	-Wundefined-bool-conversion
1180
1181	These warn when C++ code is trying to compare 'this' against NULL, while
1182	'this' should never be NULL in well-defined C++ code.  However, there is
1183	some legacy (pre C++11) code out there, which actively abuses this
1184	feature, which was less strictly defined in previous C++ versions.
1185
1186	Squid and openjdk do this, for example.  The warning can be turned off
1187	for C++98 and earlier, but compiling the code in C++11 mode might result
1188	in unexpected behavior; for example, the parts of the program that are
1189	unreachable could be optimized away.
1190
119120141222:
1192	The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
1193	kernel sources have been removed. The .h files remain, since some
1194	utilities include them. This will need to be fixed later.
1195	If "mount -t oldnfs ..." is attempted, it will fail.
1196	If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
1197	the utilities will report errors.
1198
119920141121:
1200	The handling of LOCAL_LIB_DIRS has been altered to skip addition of
1201	directories to top level SUBDIR variable when their parent
1202	directory is included in LOCAL_DIRS.  Users with build systems with
1203	such hierarchies and without SUBDIR entries in the parent
1204	directory Makefiles should add them or add the directories to
1205	LOCAL_DIRS.
1206
120720141109:
1208	faith(4) and faithd(8) have been removed from the base system. Faith
1209	has been obsolete for a very long time.
1210
121120141104:
1212	vt(4), the new console driver, is enabled by default. It brings
1213	support for Unicode and double-width characters, as well as
1214	support for UEFI and integration with the KMS kernel video
1215	drivers.
1216
1217	You may need to update your console settings in /etc/rc.conf,
1218	most probably the keymap. During boot, /etc/rc.d/syscons will
1219	indicate what you need to do.
1220
1221	vt(4) still has issues and lacks some features compared to
1222	syscons(4). See the wiki for up-to-date information:
1223	  https://wiki.freebsd.org/Newcons
1224
1225	If you want to keep using syscons(4), you can do so by adding
1226	the following line to /boot/loader.conf:
1227	  kern.vty=sc
1228
122920141102:
1230	pjdfstest has been integrated into kyua as an opt-in test suite.
1231	Please see share/doc/pjdfstest/README for more details on how to
1232	execute it.
1233
123420141009:
1235	gperf has been removed from the base system for architectures
1236	that use clang. Ports that require gperf will obtain it from the
1237	devel/gperf port.
1238
123920140923:
1240	pjdfstest has been moved from tools/regression/pjdfstest to
1241	contrib/pjdfstest .
1242
124320140922:
1244	At svn r271982, The default linux compat kernel ABI has been adjusted
1245	to 2.6.18 in support of the linux-c6 compat ports infrastructure
1246	update.  If you wish to continue using the linux-f10 compat ports,
1247	add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
1248	encouraged to update their linux-compat packages to linux-c6 during
1249	their next update cycle.
1250
125120140729:
1252	The ofwfb driver, used to provide a graphics console on PowerPC when
1253	using vt(4), no longer allows mmap() of all physical memory. This
1254	will prevent Xorg on PowerPC with some ATI graphics cards from
1255	initializing properly unless x11-servers/xorg-server is updated to
1256	1.12.4_8 or newer.
1257
125820140723:
1259	The xdev targets have been converted to using TARGET and
1260	TARGET_ARCH instead of XDEV and XDEV_ARCH.
1261
126220140719:
1263	The default unbound configuration has been modified to address
1264	issues with reverse lookups on networks that use private
1265	address ranges.  If you use the local_unbound service, run
1266	"service local_unbound setup" as root to regenerate your
1267	configuration, then "service local_unbound reload" to load the
1268	new configuration.
1269
127020140709:
1271	The GNU texinfo and GNU info pages are not built and installed
1272	anymore, WITH_INFO knob has been added to allow to built and install
1273	them again.
1274	UPDATE: see 20150102 entry on texinfo's removal
1275
127620140708:
1277	The GNU readline library is now an INTERNALLIB - that is, it is
1278	statically linked into consumers (GDB and variants) in the base
1279	system, and the shared library is no longer installed.  The
1280	devel/readline port is available for third party software that
1281	requires readline.
1282
128320140702:
1284	The Itanium architecture (ia64) has been removed from the list of
1285	known architectures. This is the first step in the removal of the
1286	architecture.
1287
128820140701:
1289	Commit r268115 has added NFSv4.1 server support, merged from
1290	projects/nfsv4.1-server.  Since this includes changes to the
1291	internal interfaces between the NFS related modules, a full
1292	build of the kernel and modules will be necessary.
1293	__FreeBSD_version has been bumped.
1294
129520140629:
1296	The WITHOUT_VT_SUPPORT kernel config knob has been renamed
1297	WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
1298	which differs from the behaviour controlled by this knob.)
1299
130020140619:
1301	Maximal length of the serial number in CTL was increased from 16 to
1302	64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
1303	and ctld, need to be rebuilt to work with a new kernel.
1304
130520140606:
1306	The libatf-c and libatf-c++ major versions were downgraded to 0 and
1307	1 respectively to match the upstream numbers.  They were out of
1308	sync because, when they were originally added to FreeBSD, the
1309	upstream versions were not respected.  These libraries are private
1310	and not yet built by default, so renumbering them should be a
1311	non-issue.  However, unclean source trees will yield broken test
1312	programs once the operator executes "make delete-old-libs" after a
1313	"make installworld".
1314
1315	Additionally, the atf-sh binary was made private by moving it into
1316	/usr/libexec/.  Already-built shell test programs will keep the
1317	path to the old binary so they will break after "make delete-old"
1318	is run.
1319
1320	If you are using WITH_TESTS=yes (not the default), wipe the object
1321	tree and rebuild from scratch to prevent spurious test failures.
1322	This is only needed once: the misnumbered libraries and misplaced
1323	binaries have been added to OptionalObsoleteFiles.inc so they will
1324	be removed during a clean upgrade.
1325
132620140512:
1327	Clang and llvm have been upgraded to 3.4.1 release.
1328
132920140508:
1330	We bogusly installed src.opts.mk in /usr/share/mk. This file should
1331	be removed to avoid issues in the future (and has been added to
1332	ObsoleteFiles.inc).
1333
133420140505:
1335	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
1336	past, it affected all builds that used the bsd.*.mk files. The old
1337	behavior was a bug, but people may have relied upon it. To get this
1338	behavior back, you can .include /etc/src.conf from /etc/make.conf
1339	(which is still global and isn't changed). This also changes the
1340	behavior of incremental builds inside the tree of individual
1341	directories. Set MAKESYSPATH to ".../share/mk" to do that.
1342	Although this has survived make universe and some upgrade scenarios,
1343	other upgrade scenarios may have broken. At least one form of
1344	temporary breakage was fixed with MAKESYSPATH settings for buildworld
1345	as well... In cases where MAKESYSPATH isn't working with this
1346	setting, you'll need to set it to the full path to your tree.
1347
1348	One side effect of all this cleaning up is that bsd.compiler.mk
1349	is no longer implicitly included by bsd.own.mk. If you wish to
1350	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
1351	as well.
1352
135320140430:
1354	The lindev device has been removed since /dev/full has been made a
1355	standard device.  __FreeBSD_version has been bumped.
1356
135720140424:
1358	The knob WITHOUT_VI was added to the base system, which controls
1359	building ex(1), vi(1), etc. Older releases of FreeBSD required ex(1)
1360	in order to reorder files share/termcap and didn't build ex(1) as a
1361	build tool, so building/installing with WITH_VI is highly advised for
1362	build hosts for older releases.
1363
1364	This issue has been fixed in stable/9 and stable/10 in r277022 and
1365	r276991, respectively.
1366
136720140418:
1368	The YES_HESIOD knob has been removed. It has been obsolete for
1369	a decade. Please move to using WITH_HESIOD instead or your builds
1370	will silently lack HESIOD.
1371
137220140405:
1373	The uart(4) driver has been changed with respect to its handling
1374	of the low-level console. Previously the uart(4) driver prevented
1375	any process from changing the baudrate or the CLOCAL and HUPCL
1376	control flags. By removing the restrictions, operators can make
1377	changes to the serial console port without having to reboot.
1378	However, when getty(8) is started on the serial device that is
1379	associated with the low-level console, a misconfigured terminal
1380	line in /etc/ttys will now have a real impact.
1381	Before upgrading the kernel, make sure that /etc/ttys has the
1382	serial console device configured as 3wire without baudrate to
1383	preserve the previous behaviour. E.g:
1384	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
1385
138620140306:
1387	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
1388	to improve performance.  To re-enable it, if needed, run rpcbind
1389	with command line option -W.
1390
139120140226:
1392	Switched back to the GPL dtc compiler due to updates in the upstream
1393	dts files not being supported by the BSDL dtc compiler. You will need
1394	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
1395	may result while building dtb files during a kernel build if you fail
1396	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
1397
139820140216:
1399	Clang and llvm have been upgraded to 3.4 release.
1400
140120140216:
1402	The nve(4) driver has been removed.  Please use the nfe(4) driver
1403	for NVIDIA nForce MCP Ethernet adapters instead.
1404
140520140212:
1406	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
1407	This could cause certain C++ applications using shared libraries built
1408	against the previous version of libc++ to crash.  The incompatibility
1409	has now been fixed, but any C++ applications or shared libraries built
1410	between r261283 and r261801 should be recompiled.
1411
141220140204:
1413	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
1414	capability mode support.  Please note that enabling the feature in
1415	kernel is still highly recommended.
1416
141720140131:
1418	OpenSSH is now built with sandbox support, and will use sandbox as
1419	the default privilege separation method.  This requires Capsicum
1420	capability mode support in kernel.
1421
142220140128:
1423	The libelf and libdwarf libraries have been updated to newer
1424	versions from upstream. Shared library version numbers for
1425	these two libraries were bumped. Any ports or binaries
1426	requiring these two libraries should be recompiled.
1427	__FreeBSD_version is bumped to 1100006.
1428
142920140110:
1430	If a Makefile in a tests/ directory was auto-generating a Kyuafile
1431	instead of providing an explicit one, this would prevent such
1432	Makefile from providing its own Kyuafile in the future during
1433	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
1434	intervention is needed to clean an objdir if you use NO_CLEAN:
1435	  # find /usr/obj -name Kyuafile | xargs rm -f
1436
143720131213:
1438	The behavior of gss_pseudo_random() for the krb5 mechanism
1439	has changed, for applications requesting a longer random string
1440	than produced by the underlying enctype's pseudo-random() function.
1441	In particular, the random string produced from a session key of
1442	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
1443	be different at the 17th octet and later, after this change.
1444	The counter used in the PRF+ construction is now encoded as a
1445	big-endian integer in accordance with RFC 4402.
1446	__FreeBSD_version is bumped to 1100004.
1447
144820131108:
1449	The WITHOUT_ATF build knob has been removed and its functionality
1450	has been subsumed into the more generic WITHOUT_TESTS.  If you were
1451	using the former to disable the build of the ATF libraries, you
1452	should change your settings to use the latter.
1453
145420131025:
1455	The default version of mtree is nmtree which is obtained from
1456	NetBSD.  The output is generally the same, but may vary
1457	slightly.  If you found you need identical output adding
1458	"-F freebsd9" to the command line should do the trick.  For the
1459	time being, the old mtree is available as fmtree.
1460
146120131014:
1462	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
1463	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
1464	1.1.4_8 and verify bsdyml not linked in, before running "make
1465	delete-old-libs":
1466	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
1467	  or
1468	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
1469
147020131010:
1471	The stable/10 branch has been created in subversion from head
1472	revision r256279.
1473
1474COMMON ITEMS:
1475
1476	General Notes
1477	-------------
1478	Avoid using make -j when upgrading.  While generally safe, there are
1479	sometimes problems using -j to upgrade.  If your upgrade fails with
1480	-j, please try again without -j.  From time to time in the past there
1481	have been problems using -j with buildworld and/or installworld.  This
1482	is especially true when upgrading between "distant" versions (eg one
1483	that cross a major release boundary or several minor releases, or when
1484	several months have passed on the -current branch).
1485
1486	Sometimes, obscure build problems are the result of environment
1487	poisoning.  This can happen because the make utility reads its
1488	environment when searching for values for global variables.  To run
1489	your build attempts in an "environmental clean room", prefix all make
1490	commands with 'env -i '.  See the env(1) manual page for more details.
1491
1492	When upgrading from one major version to another it is generally best to
1493	upgrade to the latest code in the currently installed branch first, then
1494	do an upgrade to the new branch. This is the best-tested upgrade path,
1495	and has the highest probability of being successful.  Please try this
1496	approach if you encounter problems with a major version upgrade.  Since
1497	the stable 4.x branch point, one has generally been able to upgrade from
1498	anywhere in the most recent stable branch to head / current (or even the
1499	last couple of stable branches). See the top of this file when there's
1500	an exception.
1501
1502	When upgrading a live system, having a root shell around before
1503	installing anything can help undo problems. Not having a root shell
1504	around can lead to problems if pam has changed too much from your
1505	starting point to allow continued authentication after the upgrade.
1506
1507	This file should be read as a log of events. When a later event changes
1508	information of a prior event, the prior event should not be deleted.
1509	Instead, a pointer to the entry with the new information should be
1510	placed in the old entry. Readers of this file should also sanity check
1511	older entries before relying on them blindly. Authors of new entries
1512	should write them with this in mind.
1513
1514	ZFS notes
1515	---------
1516	When upgrading the boot ZFS pool to a new version, always follow
1517	these two steps:
1518
1519	1.) recompile and reinstall the ZFS boot loader and boot block
1520	(this is part of "make buildworld" and "make installworld")
1521
1522	2.) update the ZFS boot block on your boot drive
1523
1524	The following example updates the ZFS boot block on the first
1525	partition (freebsd-boot) of a GPT partitioned drive ada0:
1526	"gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
1527
1528	Non-boot pools do not need these updates.
1529
1530	To build a kernel
1531	-----------------
1532	If you are updating from a prior version of FreeBSD (even one just
1533	a few days old), you should follow this procedure.  It is the most
1534	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1535
1536	make kernel-toolchain
1537	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1538	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1539
1540	To test a kernel once
1541	---------------------
1542	If you just want to boot a kernel once (because you are not sure
1543	if it works, or if you want to boot a known bad kernel to provide
1544	debugging information) run
1545	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1546	nextboot -k testkernel
1547
1548	To rebuild everything and install it on the current system.
1549	-----------------------------------------------------------
1550	# Note: sometimes if you are running current you gotta do more than
1551	# is listed here if you are upgrading from a really old current.
1552
1553	<make sure you have good level 0 dumps>
1554	make buildworld
1555	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1556	make installkernel KERNCONF=YOUR_KERNEL_HERE
1557							[1]
1558	<reboot in single user>				[3]
1559	mergemaster -Fp					[5]
1560	make installworld
1561	mergemaster -Fi					[4]
1562	make delete-old					[6]
1563	<reboot>
1564
1565	To cross-install current onto a separate partition
1566	--------------------------------------------------
1567	# In this approach we use a separate partition to hold
1568	# current's root, 'usr', and 'var' directories.   A partition
1569	# holding "/", "/usr" and "/var" should be about 2GB in
1570	# size.
1571
1572	<make sure you have good level 0 dumps>
1573	<boot into -stable>
1574	make buildworld
1575	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1576	<maybe newfs current's root partition>
1577	<mount current's root partition on directory ${CURRENT_ROOT}>
1578	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
1579	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1580	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1581	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
1582	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1583	<reboot into current>
1584	<do a "native" rebuild/install as described in the previous section>
1585	<maybe install compatibility libraries from ports/misc/compat*>
1586	<reboot>
1587
1588
1589	To upgrade in-place from stable to current
1590	----------------------------------------------
1591	<make sure you have good level 0 dumps>
1592	make buildworld					[9]
1593	make buildkernel KERNCONF=YOUR_KERNEL_HERE	[8]
1594	make installkernel KERNCONF=YOUR_KERNEL_HERE
1595							[1]
1596	<reboot in single user>				[3]
1597	mergemaster -Fp					[5]
1598	make installworld
1599	mergemaster -Fi					[4]
1600	make delete-old					[6]
1601	<reboot>
1602
1603	Make sure that you've read the UPDATING file to understand the
1604	tweaks to various things you need.  At this point in the life
1605	cycle of current, things change often and you are on your own
1606	to cope.  The defaults can also change, so please read ALL of
1607	the UPDATING entries.
1608
1609	Also, if you are tracking -current, you must be subscribed to
1610	freebsd-current@freebsd.org.  Make sure that before you update
1611	your sources that you have read and understood all the recent
1612	messages there.  If in doubt, please track -stable which has
1613	much fewer pitfalls.
1614
1615	[1] If you have third party modules, such as vmware, you
1616	should disable them at this point so they don't crash your
1617	system on reboot.
1618
1619	[3] From the bootblocks, boot -s, and then do
1620		fsck -p
1621		mount -u /
1622		mount -a
1623		cd src
1624		adjkerntz -i		# if CMOS is wall time
1625	Also, when doing a major release upgrade, it is required that
1626	you boot into single user mode to do the installworld.
1627
1628	[4] Note: This step is non-optional.  Failure to do this step
1629	can result in a significant reduction in the functionality of the
1630	system.  Attempting to do it by hand is not recommended and those
1631	that pursue this avenue should read this file carefully, as well
1632	as the archives of freebsd-current and freebsd-hackers mailing lists
1633	for potential gotchas.  The -U option is also useful to consider.
1634	See mergemaster(8) for more information.
1635
1636	[5] Usually this step is a no-op.  However, from time to time
1637	you may need to do this if you get unknown user in the following
1638	step.  It never hurts to do it all the time.  You may need to
1639	install a new mergemaster (cd src/usr.sbin/mergemaster && make
1640	install) after the buildworld before this step if you last updated
1641	from current before 20130425 or from -stable before 20130430.
1642
1643	[6] This only deletes old files and directories. Old libraries
1644	can be deleted by "make delete-old-libs", but you have to make
1645	sure that no program is using those libraries anymore.
1646
1647	[8] In order to have a kernel that can run the 4.x binaries needed to
1648	do an installworld, you must include the COMPAT_FREEBSD4 option in
1649	your kernel.  Failure to do so may leave you with a system that is
1650	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1651	required to run the 5.x binaries on more recent kernels.  And so on
1652	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1653
1654	Make sure that you merge any new devices from GENERIC since the
1655	last time you updated your kernel config file.
1656
1657	[9] If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1658	"?=" instead of the "=" assignment operator, so that buildworld can
1659	override the CPUTYPE if it needs to.
1660
1661	MAKEOBJDIRPREFIX must be defined in an environment variable, and
1662	not on the command line, or in /etc/make.conf.  buildworld will
1663	warn if it is improperly defined.
1664FORMAT:
1665
1666This file contains a list, in reverse chronological order, of major
1667breakages in tracking -current.  It is not guaranteed to be a complete
1668list of such breakages, and only contains entries since September 23, 2011.
1669If you need to see UPDATING entries from before that date, you will need
1670to fetch an UPDATING file from an older FreeBSD release.
1671
1672Copyright information:
1673
1674Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1675
1676Redistribution, publication, translation and use, with or without
1677modification, in full or in part, in any form or format of this
1678document are permitted without further permission from the author.
1679
1680THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1681IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1682WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1683DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1684INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1685(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1686SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1687HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1688STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1689IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1690POSSIBILITY OF SUCH DAMAGE.
1691
1692Contact Warner Losh if you have any questions about your use of
1693this document.
1694
1695$FreeBSD$
1696