xref: /freebsd/UPDATING (revision c685956956793831f724177309eace82c4b347b9)
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/updating-src.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
5420170728:
55	As of r321665, an NFSv4 server configuration that services
56	Kerberos mounts or clients that do not support the uid/gid in
57	owner/owner_group string capability, must explicitly enable
58	the nfsuserd daemon by adding nfsuserd_enable="YES" to the
59	machine's /etc/rc.conf file.
60
6120170722:
62	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 5.0.0.
63	Please see the 20141231 entry below for information about prerequisites
64	and upgrading, if you are not already using clang 3.5.0 or higher.
65
6620170701:
67	WITHOUT_RCMDS is now the default. Set WITH_RCMDS if you need them to be
68	built with the base system.
69
7020170625:
71	The FreeBSD/powerpc platform now uses a 64-bit type for time_t.  This is
72	a very major ABI incompatible change, so users of FreeBSD/powerpc must
73	be careful when performing source upgrades.  It is best to run
74	'make installworld' from an alternate root system, either a live
75	CD/memory stick, or a temporary root partition.  Additionally, all ports
76	must be recompiled.  powerpc64 is largely unaffected, except in the case
77	of 32-bit compatibility.  All 32-bit binaries will be affected.
78
7920170623:
80	Forward compatibility for the "ino64" project have been committed. This
81	will allow most new binaries to run on older kernels in a limited
82	fashion.  This prevents many of the common foot-shooting actions in the
83	upgrade as well as the limited ability to roll back the kernel across
84	the ino64 upgrade. Complicated use cases may not work properly, though
85	enough simpler ones work to allow recovery in most situations.
86
8720170620:
88	Switch back to the BSDL dtc (Device Tree Compiler). Set WITH_GPL_DTC
89	if you require the GPL compiler.
90
9120170618:
92	The internal ABI used for communication between the NFS kernel modules
93	was changed by r320085, so __FreeBSD_version was bumped to
94	ensure all the NFS related modules are updated together.
95
9620170617:
97	The ABI of struct event was changed by extending the data
98	member to 64bit and adding ext fields.  For upgrade, same
99	precautions as for the entry 20170523 "ino64" must be
100	followed.
101
10220170531:
103	The GNU roff toolchain has been removed from base. To render manpages
104	which are not supported by mandoc(1), man(1) can fallback on GNU roff
105	from ports (and recommends to install it).
106	To render roff(7) documents, consider using GNU roff from ports or the
107	heirloom doctools roff toolchain from ports via pkg install groff or
108	via pkg install heirloom-doctools.
109
11020170524:
111	The ath(4) and ath_hal(4) modules now build piecemeal to allow for
112	smaller runtime footprint builds.  This is useful for embedded systems
113	which only require one chipset support.
114
115	If you load it as a module, make sure this is in /boot/loader.conf:
116
117	if_ath_load="YES"
118
119	This will load the HAL, all chip/RF backends and if_ath_pci.
120	If you have if_ath_pci in /boot/loader.conf, ensure it is after
121	if_ath or it will not load any HAL chipset support.
122
123	If you want to selectively load things (eg on ye cheape ARM/MIPS
124	platforms where RAM is at a premium) you should:
125
126	* load ath_hal
127	* load the chip modules in question
128	* load ath_rate, ath_dfs
129	* load ath_main
130	* load if_ath_pci and/or if_ath_ahb depending upon your particular
131	  bus bind type - this is where probe/attach is done.
132
133	For further comments/feedback, poke adrian@ .
134
13520170523:
136	The "ino64" 64-bit inode project has been committed, which extends
137	a number of types to 64 bits.  Upgrading in place requires care and
138	adherence to the documented upgrade procedure.
139
140	If using a custom kernel configuration ensure that the
141	COMPAT_FREEBSD11 option is included (as during the upgrade the
142	system will be running the ino64 kernel with the existing world).
143
144	For the safest in-place upgrade begin by removing previous build
145	artifacts via "rm -rf /usr/obj/*".   Then, carefully follow the
146	full procedure documented below under the heading "To rebuild
147	everything and install it on the current system."  Specifically,
148	a reboot is required after installing the new kernel before
149	installing world.
150
15120170424:
152	The NATM framework including the en(4), fatm(4), hatm(4), and
153	patm(4) devices has been removed.  Consumers should plan a
154	migration before the end-of-life date for FreeBSD 11.
155
15620170420:
157	GNU diff has been replaced by a BSD licensed diff. Some features of GNU
158	diff has not been implemented, if those are needed a newer version of
159	GNU diff is available via the diffutils package under the gdiff name.
160
16120170413:
162	As of r316810 for ipfilter, keep frags is no longer assumed when
163	keep state is specified in a rule. r316810 aligns ipfilter with
164	documentation in man pages separating keep frags from keep state.
165	This allows keep state to be specified without forcing keep frags
166	and allows keep frags to be specified independently of keep state.
167	To maintain previous behaviour, also specify keep frags with
168	keep state (as documented in ipf.conf.5).
169
17020170407:
171	arm64 builds now use the base system LLD 4.0.0 linker by default,
172	instead of requiring that the aarch64-binutils port or package be
173	installed. To continue using aarch64-binutils, set
174	CROSS_BINUTILS_PREFIX=/usr/local/aarch64-freebsd/bin .
175
17620170405:
177	The UDP optimization in entry 20160818 that added the sysctl
178	net.inet.udp.require_l2_bcast has been reverted.  L2 broadcast
179	packets will no longer be treated as L3 broadcast packets.
180
18120170331:
182	Binds and sends to the loopback addresses, IPv6 and IPv4, will now
183	use any explicitly assigned loopback address available in the jail
184	instead of using the first assigned address of the jail.
185
18620170329:
187	The ctl.ko module no longer implements the iSCSI target frontend:
188	cfiscsi.ko does instead.
189
190	If building cfiscsi.ko as a kernel module, the module can be loaded
191	via one of the following methods:
192	- `cfiscsi_load="YES"` in loader.conf(5).
193	- Add `cfiscsi` to `$kld_list` in rc.conf(5).
194	- ctladm(8)/ctld(8), when compiled with iSCSI support
195	  (`WITH_ISCSI=yes` in src.conf(5))
196
197	Please see cfiscsi(4) for more details.
198
19920170316:
200	The mmcsd.ko module now additionally depends on geom_flashmap.ko.
201	Also, mmc.ko and mmcsd.ko need to be a matching pair built from the
202	same source (previously, the dependency of mmcsd.ko on mmc.ko was
203	missing, but mmcsd.ko now will refuse to load if it is incompatible
204	with mmc.ko).
205
20620170315:
207	The syntax of ipfw(8) named states was changed to avoid ambiguity.
208	If you have used named states in the firewall rules, you need to modify
209	them after installworld and before rebooting. Now named states must
210	be prefixed with colon.
211
21220170311:
213	The old drm (sys/dev/drm/) drivers for i915 and radeon have been
214	removed as the userland we provide cannot use them. The KMS version
215	(sys/dev/drm2) supports the same hardware.
216
21720170302:
218	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 4.0.0.
219	Please see the 20141231 entry below for information about prerequisites
220	and upgrading, if you are not already using clang 3.5.0 or higher.
221
22220170221:
223	The code that provides support for ZFS .zfs/ directory functionality
224	has been reimplemented.  It's not possible now to create a snapshot
225	by mkdir under .zfs/snapshot/.  That should be the only user visible
226	change.
227
22820170216:
229	EISA bus support has been removed. The WITH_EISA option is no longer
230	valid.
231
23220170215:
233	MCA bus support has been removed.
234
23520170127:
236	The WITH_LLD_AS_LD / WITHOUT_LLD_AS_LD build knobs have been renamed
237	WITH_LLD_IS_LD / WITHOUT_LLD_IS_LD, for consistency with CLANG_IS_CC.
238
23920170112:
240	The EM_MULTIQUEUE kernel configuration option is deprecated now that
241	the em(4) driver conforms to iflib specifications.
242
24320170109:
244	The igb(4), em(4) and lem(4) ethernet drivers are now implemented via
245	IFLIB.  If you have a custom kernel configuration that excludes em(4)
246	but you use igb(4), you need to re-add em(4) to your custom configuration.
247
24820161217:
249	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.1.
250	Please see the 20141231 entry below for information about prerequisites
251	and upgrading, if you are not already using clang 3.5.0 or higher.
252
25320161124:
254	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.0.
255	Please see the 20141231 entry below for information about prerequisites
256	and upgrading, if you are not already using clang 3.5.0 or higher.
257
25820161119:
259	The layout of the pmap structure has changed for powerpc to put the pmap
260	statistics at the front for all CPU variations.  libkvm(3) and all tools
261	that link against it need to be recompiled.
262
26320161030:
264	isl(4) and cyapa(4) drivers now require a new driver,
265	chromebook_platform(4), to work properly on Chromebook-class hardware.
266	On other types of hardware the drivers may need to be configured using
267	device hints.  Please see the corresponding manual pages for details.
268
26920161017:
270	The urtwn(4) driver was merged into rtwn(4) and now consists of
271	rtwn(4) main module + rtwn_usb(4) and rtwn_pci(4) bus-specific
272	parts.
273	Also, firmware for RTL8188CE was renamed due to possible name
274	conflict (rtwnrtl8192cU(B) -> rtwnrtl8192cE(B))
275
27620161015:
277	GNU rcs has been removed from base.  It is available as packages:
278	- rcs: Latest GPLv3 GNU rcs version.
279	- rcs57: Copy of the latest version of GNU rcs (GPLv2) before it was
280	removed from base.
281
28220161008:
283	Use of the cc_cdg, cc_chd, cc_hd, or cc_vegas congestion control
284	modules now requires that the kernel configuration contain the
285	TCP_HHOOK option. (This option is included in the GENERIC kernel.)
286
28720161003:
288	The WITHOUT_ELFCOPY_AS_OBJCOPY src.conf(5) knob has been retired.
289	ELF Tool Chain's elfcopy is always installed as /usr/bin/objcopy.
290
29120160924:
292	Relocatable object files with the extension of .So have been renamed
293	to use an extension of .pico instead.  The purpose of this change is
294	to avoid a name clash with shared libraries on case-insensitive file
295	systems.  On those file systems, foo.So is the same file as foo.so.
296
29720160918:
298	GNU rcs has been turned off by default.  It can (temporarily) be built
299	again by adding WITH_RCS knob in src.conf.
300	Otherwise, GNU rcs is available from packages:
301	- rcs: Latest GPLv3 GNU rcs version.
302	- rcs57: Copy of the latest version of GNU rcs (GPLv2) from base.
303
30420160918:
305	The backup_uses_rcs functionality has been removed from rc.subr.
306
30720160908:
308	The queue(3) debugging macro, QUEUE_MACRO_DEBUG, has been split into
309	two separate components, QUEUE_MACRO_DEBUG_TRACE and
310	QUEUE_MACRO_DEBUG_TRASH.  Define both for the original
311	QUEUE_MACRO_DEBUG behavior.
312
31320160824:
314	r304787 changed some ioctl interfaces between the iSCSI userspace
315	programs and the kernel.  ctladm, ctld, iscsictl, and iscsid must be
316	rebuilt to work with new kernels.  __FreeBSD_version has been bumped
317	to 1200005.
318
31920160818:
320	The UDP receive code has been updated to only treat incoming UDP
321	packets that were addressed to an L2 broadcast address as L3
322	broadcast packets.  It is not expected that this will affect any
323	standards-conforming UDP application.  The new behaviour can be
324	disabled by setting the sysctl net.inet.udp.require_l2_bcast to
325	0.
326
32720160818:
328	Remove the openbsd_poll system call.
329	__FreeBSD_version has been bumped because of this.
330
33120160622:
332	The libc stub for the pipe(2) system call has been replaced with
333	a wrapper that calls the pipe2(2) system call and the pipe(2)
334	system call is now only implemented by the kernels that include
335	"options COMPAT_FREEBSD10" in their config file (this is the
336	default).  Users should ensure that this option is enabled in
337	their kernel or upgrade userspace to r302092 before upgrading their
338	kernel.
339
34020160527:
341	CAM will now strip leading spaces from SCSI disks' serial numbers.
342	This will affect users who create UFS filesystems on SCSI disks using
343	those disk's diskid device nodes.  For example, if /etc/fstab
344	previously contained a line like
345	"/dev/diskid/DISK-%20%20%20%20%20%20%20ABCDEFG0123456", you should
346	change it to "/dev/diskid/DISK-ABCDEFG0123456".  Users of geom
347	transforms like gmirror may also be affected.  ZFS users should
348	generally be fine.
349
35020160523:
351	The bitstring(3) API has been updated with new functionality and
352	improved performance.  But it is binary-incompatible with the old API.
353	Objects built with the new headers may not be linked against objects
354	built with the old headers.
355
35620160520:
357	The brk and sbrk functions have been removed from libc on arm64.
358	Binutils from ports has been updated to not link to these
359	functions and should be updated to the latest version before
360	installing a new libc.
361
36220160517:
363	The armv6 port now defaults to hard float ABI. Limited support
364	for running both hardfloat and soft float on the same system
365	is available using the libraries installed with -DWITH_LIBSOFT.
366	This has only been tested as an upgrade path for installworld
367	and packages may fail or need manual intervention to run. New
368	packages will be needed.
369
370	To update an existing self-hosted armv6hf system, you must add
371	TARGET_ARCH=armv6 on the make command line for both the build
372	and the install steps.
373
37420160510:
375	Kernel modules compiled outside of a kernel build now default to
376	installing to /boot/modules instead of /boot/kernel.  Many kernel
377	modules built this way (such as those in ports) already overrode
378	KMODDIR explicitly to install into /boot/modules.  However,
379	manually building and installing a module from /sys/modules will
380	now install to /boot/modules instead of /boot/kernel.
381
38220160414:
383	The CAM I/O scheduler has been committed to the kernel. There should be
384	no user visible impact. This does enable NCQ Trim on ada SSDs. While the
385	list of known rogues that claim support for this but actually corrupt
386	data is believed to be complete, be on the lookout for data
387	corruption. The known rogue list is believed to be complete:
388
389		o Crucial MX100, M550 drives with MU01 firmware.
390		o Micron M510 and M550 drives with MU01 firmware.
391		o Micron M500 prior to MU07 firmware
392		o Samsung 830, 840, and 850 all firmwares
393		o FCCT M500 all firmwares
394
395	Crucial has firmware http://www.crucial.com/usa/en/support-ssd-firmware
396	with working NCQ TRIM. For Micron branded drives, see your sales rep for
397	updated firmware. Black listed drives will work correctly because these
398	drives work correctly so long as no NCQ TRIMs are sent to them. Given
399	this list is the same as found in Linux, it's believed there are no
400	other rogues in the market place. All other models from the above
401	vendors work.
402
403	To be safe, if you are at all concerned, you can quirk each of your
404	drives to prevent NCQ from being sent by setting:
405		kern.cam.ada.X.quirks="0x2"
406	in loader.conf. If the drive requires the 4k sector quirk, set the
407	quirks entry to 0x3.
408
40920160330:
410	The FAST_DEPEND build option has been removed and its functionality is
411	now the one true way.  The old mkdep(1) style of 'make depend' has
412	been removed.  See 20160311 for further details.
413
41420160317:
415	Resource range types have grown from unsigned long to uintmax_t.  All
416	drivers, and anything using libdevinfo, need to be recompiled.
417
41820160311:
419	WITH_FAST_DEPEND is now enabled by default for in-tree and out-of-tree
420	builds.  It no longer runs mkdep(1) during 'make depend', and the
421	'make depend' stage can safely be skipped now as it is auto ran
422	when building 'make all' and will generate all SRCS and DPSRCS before
423	building anything else.  Dependencies are gathered at compile time with
424	-MF flags kept in separate .depend files per object file.  Users should
425	run 'make cleandepend' once if using -DNO_CLEAN to clean out older
426	stale .depend files.
427
42820160306:
429	On amd64, clang 3.8.0 can now insert sections of type AMD64_UNWIND into
430	kernel modules.  Therefore, if you load any kernel modules at boot time,
431	please install the boot loaders after you install the kernel, but before
432	rebooting, e.g.:
433
434	make buildworld
435	make kernel KERNCONF=YOUR_KERNEL_HERE
436	make -C sys/boot install
437	<reboot in single user>
438
439	Then follow the usual steps, described in the General Notes section,
440	below.
441
44220160305:
443	Clang, llvm, lldb and compiler-rt have been upgraded to 3.8.0.  Please
444	see the 20141231 entry below for information about prerequisites and
445	upgrading, if you are not already using clang 3.5.0 or higher.
446
44720160301:
448	The AIO subsystem is now a standard part of the kernel.  The
449	VFS_AIO kernel option and aio.ko kernel module have been removed.
450	Due to stability concerns, asynchronous I/O requests are only
451	permitted on sockets and raw disks by default.  To enable
452	asynchronous I/O requests on all file types, set the
453	vfs.aio.enable_unsafe sysctl to a non-zero value.
454
45520160226:
456	The ELF object manipulation tool objcopy is now provided by the
457	ELF Tool Chain project rather than by GNU binutils. It should be a
458	drop-in replacement, with the addition of arm64 support. The
459	(temporary) src.conf knob WITHOUT_ELFCOPY_AS_OBJCOPY knob may be set
460	to obtain the GNU version if necessary.
461
46220160129:
463	Building ZFS pools on top of zvols is prohibited by default.  That
464	feature has never worked safely; it's always been prone to deadlocks.
465	Using a zvol as the backing store for a VM guest's virtual disk will
466	still work, even if the guest is using ZFS.  Legacy behavior can be
467	restored by setting vfs.zfs.vol.recursive=1.
468
46920160119:
470	The NONE and HPN patches has been removed from OpenSSH.  They are
471	still available in the security/openssh-portable port.
472
47320160113:
474	With the addition of ypldap(8), a new _ypldap user is now required
475	during installworld. "mergemaster -p" can be used to add the user
476	prior to installworld, as documented in the handbook.
477
47820151216:
479	The tftp loader (pxeboot) now uses the option root-path directive. As a
480	consequence it no longer looks for a pxeboot.4th file on the tftp
481	server. Instead it uses the regular /boot infrastructure as with the
482	other loaders.
483
48420151211:
485	The code to start recording plug and play data into the modules has
486	been committed. While the old tools will properly build a new kernel,
487	a number of warnings about "unknown metadata record 4" will be produced
488	for an older kldxref. To avoid such warnings, make sure to rebuild
489	the kernel toolchain (or world). Make sure that you have r292078 or
490	later when trying to build 292077 or later before rebuilding.
491
49220151207:
493	Debug data files are now built by default with 'make buildworld' and
494	installed with 'make installworld'. This facilitates debugging but
495	requires more disk space both during the build and for the installed
496	world. Debug files may be disabled by setting WITHOUT_DEBUG_FILES=yes
497	in src.conf(5).
498
49920151130:
500	r291527 changed the internal interface between the nfsd.ko and
501	nfscommon.ko modules. As such, they must both be upgraded to-gether.
502	__FreeBSD_version has been bumped because of this.
503
50420151108:
505	Add support for unicode collation strings leads to a change of
506	order of files listed by ls(1) for example. To get back to the old
507	behaviour, set LC_COLLATE environment variable to "C".
508
509	Databases administrators will need to reindex their databases given
510	collation results will be different.
511
512	Due to a bug in install(1) it is recommended to remove the ancient
513	locales before running make installworld.
514
515	rm -rf /usr/share/locale/*
516
51720151030:
518	The OpenSSL has been upgraded to 1.0.2d.  Any binaries requiring
519	libcrypto.so.7 or libssl.so.7 must be recompiled.
520
52120151020:
522	Qlogic 24xx/25xx firmware images were updated from 5.5.0 to 7.3.0.
523	Kernel modules isp_2400_multi and isp_2500_multi were removed and
524	should be replaced with isp_2400 and isp_2500 modules respectively.
525
52620151017:
527	The build previously allowed using 'make -n' to not recurse into
528	sub-directories while showing what commands would be executed, and
529	'make -n -n' to recursively show commands.  Now 'make -n' will recurse
530	and 'make -N' will not.
531
53220151012:
533	If you specify SENDMAIL_MC or SENDMAIL_CF in make.conf, mergemaster
534	and etcupdate will now use this file. A custom sendmail.cf is now
535	updated via this mechanism rather than via installworld.  If you had
536	excluded sendmail.cf in mergemaster.rc or etcupdate.conf, you may
537	want to remove the exclusion or change it to "always install".
538	/etc/mail/sendmail.cf is now managed the same way regardless of
539	whether SENDMAIL_MC/SENDMAIL_CF is used.  If you are not using
540	SENDMAIL_MC/SENDMAIL_CF there should be no change in behavior.
541
54220151011:
543	Compatibility shims for legacy ATA device names have been removed.
544	It includes ATA_STATIC_ID kernel option, kern.cam.ada.legacy_aliases
545	and kern.geom.raid.legacy_aliases loader tunables, kern.devalias.*
546	environment variables, /dev/ad* and /dev/ar* symbolic links.
547
54820151006:
549	Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.7.0.
550	Please see the 20141231 entry below for information about prerequisites
551	and upgrading, if you are not already using clang 3.5.0 or higher.
552
55320150924:
554	Kernel debug files have been moved to /usr/lib/debug/boot/kernel/,
555	and renamed from .symbols to .debug. This reduces the size requirements
556	on the boot partition or file system and provides consistency with
557	userland debug files.
558
559	When using the supported kernel installation method the
560	/usr/lib/debug/boot/kernel directory will be renamed (to kernel.old)
561	as is done with /boot/kernel.
562
563	Developers wishing to maintain the historical behavior of installing
564	debug files in /boot/kernel/ can set KERN_DEBUGDIR="" in src.conf(5).
565
56620150827:
567	The wireless drivers had undergone changes that remove the 'parent
568	interface' from the ifconfig -l output. The rc.d network scripts
569	used to check presence of a parent interface in the list, so old
570	scripts would fail to start wireless networking. Thus, etcupdate(3)
571	or mergemaster(8) run is required after kernel update, to update your
572	rc.d scripts in /etc.
573
57420150827:
575	pf no longer supports 'scrub fragment crop' or 'scrub fragment drop-ovl'
576	These configurations are now automatically interpreted as
577	'scrub fragment reassemble'.
578
57920150817:
580	Kernel-loadable modules for the random(4) device are back. To use
581	them, the kernel must have
582
583	device	random
584	options	RANDOM_LOADABLE
585
586	kldload(8) can then be used to load random_fortuna.ko
587	or random_yarrow.ko. Please note that due to the indirect
588	function calls that the loadable modules need to provide,
589	the build-in variants will be slightly more efficient.
590
591	The random(4) kernel option RANDOM_DUMMY has been retired due to
592	unpopularity. It was not all that useful anyway.
593
59420150813:
595	The WITHOUT_ELFTOOLCHAIN_TOOLS src.conf(5) knob has been retired.
596	Control over building the ELF Tool Chain tools is now provided by
597	the WITHOUT_TOOLCHAIN knob.
598
59920150810:
600	The polarity of Pulse Per Second (PPS) capture events with the
601	uart(4) driver has been corrected.  Prior to this change the PPS
602	"assert" event corresponded to the trailing edge of a positive PPS
603	pulse and the "clear" event was the leading edge of the next pulse.
604
605	As the width of a PPS pulse in a typical GPS receiver is on the
606	order of 1 millisecond, most users will not notice any significant
607	difference with this change.
608
609	Anyone who has compensated for the historical polarity reversal by
610	configuring a negative offset equal to the pulse width will need to
611	remove that workaround.
612
61320150809:
614	The default group assigned to /dev/dri entries has been changed
615	from 'wheel' to 'video' with the id of '44'. If you want to have
616	access to the dri devices please add yourself to the video group
617	with:
618
619	# pw groupmod video -m $USER
620
62120150806:
622	The menu.rc and loader.rc files will now be replaced during
623	upgrades. Please migrate local changes to menu.rc.local and
624	loader.rc.local instead.
625
62620150805:
627	GNU Binutils versions of addr2line, c++filt, nm, readelf, size,
628	strings and strip have been removed. The src.conf(5) knob
629	WITHOUT_ELFTOOLCHAIN_TOOLS no longer provides the binutils tools.
630
63120150728:
632	As ZFS requires more kernel stack pages than is the default on some
633	architectures e.g. i386, it now warns if KSTACK_PAGES is less than
634	ZFS_MIN_KSTACK_PAGES (which is 4 at the time of writing).
635
636	Please consider using 'options KSTACK_PAGES=X' where X is greater
637	than or equal to ZFS_MIN_KSTACK_PAGES i.e. 4 in such configurations.
638
63920150706:
640	sendmail has been updated to 8.15.2.  Starting with FreeBSD 11.0
641	and sendmail 8.15, sendmail uses uncompressed IPv6 addresses by
642	default, i.e., they will not contain "::".  For example, instead
643	of ::1, it will be 0:0:0:0:0:0:0:1.  This permits a zero subnet
644	to have a more specific match, such as different map entries for
645	IPv6:0:0 vs IPv6:0.  This change requires that configuration
646	data (including maps, files, classes, custom ruleset, etc.) must
647	use the same format, so make certain such configuration data is
648	upgrading.  As a very simple check search for patterns like
649	'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'.  To return to the old
650	behavior, set the m4 option confUSE_COMPRESSED_IPV6_ADDRESSES or
651	the cf option UseCompressedIPv6Addresses.
652
65320150630:
654	The default kernel entropy-processing algorithm is now
655	Fortuna, replacing Yarrow.
656
657	Assuming you have 'device random' in your kernel config
658	file, the configurations allow a kernel option to override
659	this default. You may choose *ONE* of:
660
661	options	RANDOM_YARROW	# Legacy /dev/random algorithm.
662	options	RANDOM_DUMMY	# Blocking-only driver.
663
664	If you have neither, you get Fortuna.  For most people,
665	read no further, Fortuna will give a /dev/random that works
666	like it always used to, and the difference will be irrelevant.
667
668	If you remove 'device random', you get *NO* kernel-processed
669	entropy at all. This may be acceptable to folks building
670	embedded systems, but has complications. Carry on reading,
671	and it is assumed you know what you need.
672
673	*PLEASE* read random(4) and random(9) if you are in the
674	habit of tweaking kernel configs, and/or if you are a member
675	of the embedded community, wanting specific and not-usual
676	behaviour from your security subsystems.
677
678	NOTE!! If you use RANDOM_DUMMY and/or have no 'device
679	random', you will NOT have a functioning /dev/random, and
680	many cryptographic features will not work, including SSH.
681	You may also find strange behaviour from the random(3) set
682	of library functions, in particular sranddev(3), srandomdev(3)
683	and arc4random(3). The reason for this is that the KERN_ARND
684	sysctl only returns entropy if it thinks it has some to
685	share, and with RANDOM_DUMMY or no 'device random' this
686	will never happen.
687
68820150623:
689	An additional fix for the issue described in the 20150614 sendmail
690	entry below has been been committed in revision 284717.
691
69220150616:
693	FreeBSD's old make (fmake) has been removed from the system. It is
694	available as the devel/fmake port or via pkg install fmake.
695
69620150615:
697	The fix for the issue described in the 20150614 sendmail entry
698	below has been been committed in revision 284436.  The work
699	around described in that entry is no longer needed unless the
700	default setting is overridden by a confDH_PARAMETERS configuration
701	setting of '5' or pointing to a 512 bit DH parameter file.
702
70320150614:
704	ALLOW_DEPRECATED_ATF_TOOLS/ATFFILE support has been removed from
705	atf.test.mk (included from bsd.test.mk). Please upgrade devel/atf
706	and devel/kyua to version 0.20+ and adjust any calling code to work
707	with Kyuafile and kyua.
708
70920150614:
710	The import of openssl to address the FreeBSD-SA-15:10.openssl
711	security advisory includes a change which rejects handshakes
712	with DH parameters below 768 bits.  sendmail releases prior
713	to 8.15.2 (not yet released), defaulted to a 512 bit
714	DH parameter setting for client connections.  To work around
715	this interoperability, sendmail can be configured to use a
716	2048 bit DH parameter by:
717
718	1. Edit /etc/mail/`hostname`.mc
719	2. If a setting for confDH_PARAMETERS does not exist or
720	   exists and is set to a string beginning with '5',
721	   replace it with '2'.
722	3. If a setting for confDH_PARAMETERS exists and is set to
723	   a file path, create a new file with:
724		openssl dhparam -out /path/to/file 2048
725	4. Rebuild the .cf file:
726		cd /etc/mail/; make; make install
727	5. Restart sendmail:
728		cd /etc/mail/; make restart
729
730	A sendmail patch is coming, at which time this file will be
731	updated.
732
73320150604:
734	Generation of legacy formatted entries have been disabled by default
735	in pwd_mkdb(8), as all base system consumers of the legacy formatted
736	entries were converted to use the new format by default when the new,
737	machine independent format have been added and supported since FreeBSD
738	5.x.
739
740	Please see the pwd_mkdb(8) manual page for further details.
741
74220150525:
743	Clang and llvm have been upgraded to 3.6.1 release.  Please see the
744	20141231 entry below for information about prerequisites and upgrading,
745	if you are not already using 3.5.0 or higher.
746
74720150521:
748	TI platform code switched to using vendor DTS files and this update
749	may break existing systems running on Beaglebone, Beaglebone Black,
750	and Pandaboard:
751
752	- dtb files should be regenerated/reinstalled. Filenames are the
753	  same but content is different now
754	- GPIO addressing was changed, now each GPIO bank (32 pins per bank)
755	  has its own /dev/gpiocX device, e.g. pin 121 on /dev/gpioc0 in old
756	  addressing scheme is now pin 25 on /dev/gpioc3.
757	- Pandaboard: /etc/ttys should be updated, serial console device is
758	  now /dev/ttyu2, not /dev/ttyu0
759
76020150501:
761	soelim(1) from gnu/usr.bin/groff has been replaced by usr.bin/soelim.
762	If you need the GNU extension from groff soelim(1), install groff
763	from package: pkg install groff, or via ports: textproc/groff.
764
76520150423:
766	chmod, chflags, chown and chgrp now affect symlinks in -R mode as
767	defined in symlink(7); previously symlinks were silently ignored.
768
76920150415:
770	The const qualifier has been removed from iconv(3) to comply with
771	POSIX.  The ports tree is aware of this from r384038 onwards.
772
77320150416:
774	Libraries specified by LIBADD in Makefiles must have a corresponding
775	DPADD_<lib> variable to ensure correct dependencies.  This is now
776	enforced in src.libnames.mk.
777
77820150324:
779	From legacy ata(4) driver was removed support for SATA controllers
780	supported by more functional drivers ahci(4), siis(4) and mvs(4).
781	Kernel modules ataahci and ataadaptec were removed completely,
782	replaced by ahci and mvs modules respectively.
783
78420150315:
785	Clang, llvm and lldb have been upgraded to 3.6.0 release.  Please see
786	the 20141231 entry below for information about prerequisites and
787	upgrading, if you are not already using 3.5.0 or higher.
788
78920150307:
790	The 32-bit PowerPC kernel has been changed to a position-independent
791	executable. This can only be booted with a version of loader(8)
792	newer than January 31, 2015, so make sure to update both world and
793	kernel before rebooting.
794
79520150217:
796	If you are running a -CURRENT kernel since r273872 (Oct 30th, 2014),
797	but before r278950, the RNG was not seeded properly.  Immediately
798	upgrade the kernel to r278950 or later and regenerate any keys (e.g.
799	ssh keys or openssl keys) that were generated w/ a kernel from that
800	range.  This does not affect programs that directly used /dev/random
801	or /dev/urandom.  All userland uses of arc4random(3) are affected.
802
80320150210:
804	The autofs(4) ABI was changed in order to restore binary compatibility
805	with 10.1-RELEASE.  The automountd(8) daemon needs to be rebuilt to work
806	with the new kernel.
807
80820150131:
809	The powerpc64 kernel has been changed to a position-independent
810	executable. This can only be booted with a new version of loader(8),
811	so make sure to update both world and kernel before rebooting.
812
81320150118:
814	Clang and llvm have been upgraded to 3.5.1 release.  This is a bugfix
815	only release, no new features have been added.  Please see the 20141231
816	entry below for information about prerequisites and upgrading, if you
817	are not already using 3.5.0.
818
81920150107:
820	ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
821	taken from the ELF Tool Chain project rather than GNU binutils. They
822	should be drop-in replacements, with the addition of arm64 support.
823	The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
824	binutils tools, if necessary. See 20150805 for updated information.
825
82620150105:
827	The default Unbound configuration now enables remote control
828	using a local socket.  Users who have already enabled the
829	local_unbound service should regenerate their configuration
830	by running "service local_unbound setup" as root.
831
83220150102:
833	The GNU texinfo and GNU info pages have been removed.
834	To be able to view GNU info pages please install texinfo from ports.
835
83620141231:
837	Clang, llvm and lldb have been upgraded to 3.5.0 release.
838
839	As of this release, a prerequisite for building clang, llvm and lldb is
840	a C++11 capable compiler and C++11 standard library.  This means that to
841	be able to successfully build the cross-tools stage of buildworld, with
842	clang as the bootstrap compiler, your system compiler or cross compiler
843	should either be clang 3.3 or later, or gcc 4.8 or later, and your
844	system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
845	later.
846
847	On any standard FreeBSD 10.x or 11.x installation, where clang and
848	libc++ are on by default (that is, on x86 or arm), this should work out
849	of the box.
850
851	On 9.x installations where clang is enabled by default, e.g. on x86 and
852	powerpc, libc++ will not be enabled by default, so libc++ should be
853	built (with clang) and installed first.  If both clang and libc++ are
854	missing, build clang first, then use it to build libc++.
855
856	On 8.x and earlier installations, upgrade to 9.x first, and then follow
857	the instructions for 9.x above.
858
859	Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
860	default, and do not build clang.
861
862	Many embedded systems are resource constrained, and will not be able to
863	build clang in a reasonable time, or in some cases at all.  In those
864	cases, cross building bootable systems on amd64 is a workaround.
865
866	This new version of clang introduces a number of new warnings, of which
867	the following are most likely to appear:
868
869	-Wabsolute-value
870
871	This warns in two cases, for both C and C++:
872	* When the code is trying to take the absolute value of an unsigned
873	  quantity, which is effectively a no-op, and almost never what was
874	  intended.  The code should be fixed, if at all possible.  If you are
875	  sure that the unsigned quantity can be safely cast to signed, without
876	  loss of information or undefined behavior, you can add an explicit
877	  cast, or disable the warning.
878
879	* When the code is trying to take an absolute value, but the called
880	  abs() variant is for the wrong type, which can lead to truncation.
881	  If you want to disable the warning instead of fixing the code, please
882	  make sure that truncation will not occur, or it might lead to unwanted
883	  side-effects.
884
885	-Wtautological-undefined-compare and
886	-Wundefined-bool-conversion
887
888	These warn when C++ code is trying to compare 'this' against NULL, while
889	'this' should never be NULL in well-defined C++ code.  However, there is
890	some legacy (pre C++11) code out there, which actively abuses this
891	feature, which was less strictly defined in previous C++ versions.
892
893	Squid and openjdk do this, for example.  The warning can be turned off
894	for C++98 and earlier, but compiling the code in C++11 mode might result
895	in unexpected behavior; for example, the parts of the program that are
896	unreachable could be optimized away.
897
89820141222:
899	The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
900	kernel sources have been removed. The .h files remain, since some
901	utilities include them. This will need to be fixed later.
902	If "mount -t oldnfs ..." is attempted, it will fail.
903	If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
904	the utilities will report errors.
905
90620141121:
907	The handling of LOCAL_LIB_DIRS has been altered to skip addition of
908	directories to top level SUBDIR variable when their parent
909	directory is included in LOCAL_DIRS.  Users with build systems with
910	such hierarchies and without SUBDIR entries in the parent
911	directory Makefiles should add them or add the directories to
912	LOCAL_DIRS.
913
91420141109:
915	faith(4) and faithd(8) have been removed from the base system. Faith
916	has been obsolete for a very long time.
917
91820141104:
919	vt(4), the new console driver, is enabled by default. It brings
920	support for Unicode and double-width characters, as well as
921	support for UEFI and integration with the KMS kernel video
922	drivers.
923
924	You may need to update your console settings in /etc/rc.conf,
925	most probably the keymap. During boot, /etc/rc.d/syscons will
926	indicate what you need to do.
927
928	vt(4) still has issues and lacks some features compared to
929	syscons(4). See the wiki for up-to-date information:
930	  https://wiki.freebsd.org/Newcons
931
932	If you want to keep using syscons(4), you can do so by adding
933	the following line to /boot/loader.conf:
934	  kern.vty=sc
935
93620141102:
937	pjdfstest has been integrated into kyua as an opt-in test suite.
938	Please see share/doc/pjdfstest/README for more details on how to
939	execute it.
940
94120141009:
942	gperf has been removed from the base system for architectures
943	that use clang. Ports that require gperf will obtain it from the
944	devel/gperf port.
945
94620140923:
947	pjdfstest has been moved from tools/regression/pjdfstest to
948	contrib/pjdfstest .
949
95020140922:
951	At svn r271982, The default linux compat kernel ABI has been adjusted
952	to 2.6.18 in support of the linux-c6 compat ports infrastructure
953	update.  If you wish to continue using the linux-f10 compat ports,
954	add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
955	encouraged to update their linux-compat packages to linux-c6 during
956	their next update cycle.
957
95820140729:
959	The ofwfb driver, used to provide a graphics console on PowerPC when
960	using vt(4), no longer allows mmap() of all physical memory. This
961	will prevent Xorg on PowerPC with some ATI graphics cards from
962	initializing properly unless x11-servers/xorg-server is updated to
963	1.12.4_8 or newer.
964
96520140723:
966	The xdev targets have been converted to using TARGET and
967	TARGET_ARCH instead of XDEV and XDEV_ARCH.
968
96920140719:
970	The default unbound configuration has been modified to address
971	issues with reverse lookups on networks that use private
972	address ranges.  If you use the local_unbound service, run
973	"service local_unbound setup" as root to regenerate your
974	configuration, then "service local_unbound reload" to load the
975	new configuration.
976
97720140709:
978	The GNU texinfo and GNU info pages are not built and installed
979	anymore, WITH_INFO knob has been added to allow to built and install
980	them again.
981	UPDATE: see 20150102 entry on texinfo's removal
982
98320140708:
984	The GNU readline library is now an INTERNALLIB - that is, it is
985	statically linked into consumers (GDB and variants) in the base
986	system, and the shared library is no longer installed.  The
987	devel/readline port is available for third party software that
988	requires readline.
989
99020140702:
991	The Itanium architecture (ia64) has been removed from the list of
992	known architectures. This is the first step in the removal of the
993	architecture.
994
99520140701:
996	Commit r268115 has added NFSv4.1 server support, merged from
997	projects/nfsv4.1-server.  Since this includes changes to the
998	internal interfaces between the NFS related modules, a full
999	build of the kernel and modules will be necessary.
1000	__FreeBSD_version has been bumped.
1001
100220140629:
1003	The WITHOUT_VT_SUPPORT kernel config knob has been renamed
1004	WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
1005	which differs from the behaviour controlled by this knob.)
1006
100720140619:
1008	Maximal length of the serial number in CTL was increased from 16 to
1009	64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
1010	and ctld, need to be rebuilt to work with a new kernel.
1011
101220140606:
1013	The libatf-c and libatf-c++ major versions were downgraded to 0 and
1014	1 respectively to match the upstream numbers.  They were out of
1015	sync because, when they were originally added to FreeBSD, the
1016	upstream versions were not respected.  These libraries are private
1017	and not yet built by default, so renumbering them should be a
1018	non-issue.  However, unclean source trees will yield broken test
1019	programs once the operator executes "make delete-old-libs" after a
1020	"make installworld".
1021
1022	Additionally, the atf-sh binary was made private by moving it into
1023	/usr/libexec/.  Already-built shell test programs will keep the
1024	path to the old binary so they will break after "make delete-old"
1025	is run.
1026
1027	If you are using WITH_TESTS=yes (not the default), wipe the object
1028	tree and rebuild from scratch to prevent spurious test failures.
1029	This is only needed once: the misnumbered libraries and misplaced
1030	binaries have been added to OptionalObsoleteFiles.inc so they will
1031	be removed during a clean upgrade.
1032
103320140512:
1034	Clang and llvm have been upgraded to 3.4.1 release.
1035
103620140508:
1037	We bogusly installed src.opts.mk in /usr/share/mk. This file should
1038	be removed to avoid issues in the future (and has been added to
1039	ObsoleteFiles.inc).
1040
104120140505:
1042	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
1043	past, it affected all builds that used the bsd.*.mk files. The old
1044	behavior was a bug, but people may have relied upon it. To get this
1045	behavior back, you can .include /etc/src.conf from /etc/make.conf
1046	(which is still global and isn't changed). This also changes the
1047	behavior of incremental builds inside the tree of individual
1048	directories. Set MAKESYSPATH to ".../share/mk" to do that.
1049	Although this has survived make universe and some upgrade scenarios,
1050	other upgrade scenarios may have broken. At least one form of
1051	temporary breakage was fixed with MAKESYSPATH settings for buildworld
1052	as well... In cases where MAKESYSPATH isn't working with this
1053	setting, you'll need to set it to the full path to your tree.
1054
1055	One side effect of all this cleaning up is that bsd.compiler.mk
1056	is no longer implicitly included by bsd.own.mk. If you wish to
1057	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
1058	as well.
1059
106020140430:
1061	The lindev device has been removed since /dev/full has been made a
1062	standard device.  __FreeBSD_version has been bumped.
1063
106420140424:
1065	The knob WITHOUT_VI was added to the base system, which controls
1066	building ex(1), vi(1), etc. Older releases of FreeBSD required ex(1)
1067	in order to reorder files share/termcap and didn't build ex(1) as a
1068	build tool, so building/installing with WITH_VI is highly advised for
1069	build hosts for older releases.
1070
1071	This issue has been fixed in stable/9 and stable/10 in r277022 and
1072	r276991, respectively.
1073
107420140418:
1075	The YES_HESIOD knob has been removed. It has been obsolete for
1076	a decade. Please move to using WITH_HESIOD instead or your builds
1077	will silently lack HESIOD.
1078
107920140405:
1080	The uart(4) driver has been changed with respect to its handling
1081	of the low-level console. Previously the uart(4) driver prevented
1082	any process from changing the baudrate or the CLOCAL and HUPCL
1083	control flags. By removing the restrictions, operators can make
1084	changes to the serial console port without having to reboot.
1085	However, when getty(8) is started on the serial device that is
1086	associated with the low-level console, a misconfigured terminal
1087	line in /etc/ttys will now have a real impact.
1088	Before upgrading the kernel, make sure that /etc/ttys has the
1089	serial console device configured as 3wire without baudrate to
1090	preserve the previous behaviour. E.g:
1091	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
1092
109320140306:
1094	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
1095	to improve performance.  To re-enable it, if needed, run rpcbind
1096	with command line option -W.
1097
109820140226:
1099	Switched back to the GPL dtc compiler due to updates in the upstream
1100	dts files not being supported by the BSDL dtc compiler. You will need
1101	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
1102	may result while building dtb files during a kernel build if you fail
1103	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
1104
110520140216:
1106	Clang and llvm have been upgraded to 3.4 release.
1107
110820140216:
1109	The nve(4) driver has been removed.  Please use the nfe(4) driver
1110	for NVIDIA nForce MCP Ethernet adapters instead.
1111
111220140212:
1113	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
1114	This could cause certain C++ applications using shared libraries built
1115	against the previous version of libc++ to crash.  The incompatibility
1116	has now been fixed, but any C++ applications or shared libraries built
1117	between r261283 and r261801 should be recompiled.
1118
111920140204:
1120	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
1121	capability mode support.  Please note that enabling the feature in
1122	kernel is still highly recommended.
1123
112420140131:
1125	OpenSSH is now built with sandbox support, and will use sandbox as
1126	the default privilege separation method.  This requires Capsicum
1127	capability mode support in kernel.
1128
112920140128:
1130	The libelf and libdwarf libraries have been updated to newer
1131	versions from upstream. Shared library version numbers for
1132	these two libraries were bumped. Any ports or binaries
1133	requiring these two libraries should be recompiled.
1134	__FreeBSD_version is bumped to 1100006.
1135
113620140110:
1137	If a Makefile in a tests/ directory was auto-generating a Kyuafile
1138	instead of providing an explicit one, this would prevent such
1139	Makefile from providing its own Kyuafile in the future during
1140	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
1141	intervention is needed to clean an objdir if you use NO_CLEAN:
1142	  # find /usr/obj -name Kyuafile | xargs rm -f
1143
114420131213:
1145	The behavior of gss_pseudo_random() for the krb5 mechanism
1146	has changed, for applications requesting a longer random string
1147	than produced by the underlying enctype's pseudo-random() function.
1148	In particular, the random string produced from a session key of
1149	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
1150	be different at the 17th octet and later, after this change.
1151	The counter used in the PRF+ construction is now encoded as a
1152	big-endian integer in accordance with RFC 4402.
1153	__FreeBSD_version is bumped to 1100004.
1154
115520131108:
1156	The WITHOUT_ATF build knob has been removed and its functionality
1157	has been subsumed into the more generic WITHOUT_TESTS.  If you were
1158	using the former to disable the build of the ATF libraries, you
1159	should change your settings to use the latter.
1160
116120131025:
1162	The default version of mtree is nmtree which is obtained from
1163	NetBSD.  The output is generally the same, but may vary
1164	slightly.  If you found you need identical output adding
1165	"-F freebsd9" to the command line should do the trick.  For the
1166	time being, the old mtree is available as fmtree.
1167
116820131014:
1169	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
1170	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
1171	1.1.4_8 and verify bsdyml not linked in, before running "make
1172	delete-old-libs":
1173	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
1174	  or
1175	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
1176
117720131010:
1178	The stable/10 branch has been created in subversion from head
1179	revision r256279.
1180
118120131010:
1182	The rc.d/jail script has been updated to support jail(8)
1183	configuration file.  The "jail_<jname>_*" rc.conf(5) variables
1184	for per-jail configuration are automatically converted to
1185	/var/run/jail.<jname>.conf before the jail(8) utility is invoked.
1186	This is transparently backward compatible.  See below about some
1187	incompatibilities and rc.conf(5) manual page for more details.
1188
1189	These variables are now deprecated in favor of jail(8) configuration
1190	file.  One can use "rc.d/jail config <jname>" command to generate
1191	a jail(8) configuration file in /var/run/jail.<jname>.conf without
1192	running the jail(8) utility.   The default pathname of the
1193	configuration file is /etc/jail.conf and can be specified by
1194	using $jail_conf or $jail_<jname>_conf variables.
1195
1196	Please note that jail_devfs_ruleset accepts an integer at
1197	this moment.  Please consider to rewrite the ruleset name
1198	with an integer.
1199
120020130930:
1201	BIND has been removed from the base system.  If all you need
1202	is a local resolver, simply enable and start the local_unbound
1203	service instead.  Otherwise, several versions of BIND are
1204	available in the ports tree.   The dns/bind99 port is one example.
1205
1206	With this change, nslookup(1) and dig(1) are no longer in the base
1207	system.  Users should instead use host(1) and drill(1) which are
1208	in the base system.  Alternatively, nslookup and dig can
1209	be obtained by installing the dns/bind-tools port.
1210
121120130916:
1212	With the addition of unbound(8), a new unbound user is now
1213	required during installworld.  "mergemaster -p" can be used to
1214	add the user prior to installworld, as documented in the handbook.
1215
121620130911:
1217	OpenSSH is now built with DNSSEC support, and will by default
1218	silently trust signed SSHFP records.  This can be controlled with
1219	the VerifyHostKeyDNS client configuration setting.  DNSSEC support
1220	can be disabled entirely with the WITHOUT_LDNS option in src.conf.
1221
122220130906:
1223	The GNU Compiler Collection and C++ standard library (libstdc++)
1224	are no longer built by default on platforms where clang is the system
1225	compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
1226	options in src.conf.
1227
122820130905:
1229	The PROCDESC kernel option is now part of the GENERIC kernel
1230	configuration and is required for the rwhod(8) to work.
1231	If you are using custom kernel configuration, you should include
1232	'options PROCDESC'.
1233
123420130905:
1235	The API and ABI related to the Capsicum framework was modified
1236	in backward incompatible way. The userland libraries and programs
1237	have to be recompiled to work with the new kernel. This includes the
1238	following libraries and programs, but the whole buildworld is
1239	advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
1240	kdump, procstat, rwho, rwhod, uniq.
1241
124220130903:
1243	AES-NI intrinsic support has been added to gcc.  The AES-NI module
1244	has been updated to use this support.  A new gcc is required to build
1245	the aesni module on both i386 and amd64.
1246
124720130821:
1248	The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
1249	Thus "device padlock_rng" and "device rdrand_rng" should be
1250	used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
1251
125220130813:
1253	WITH_ICONV has been split into two feature sets.  WITH_ICONV now
1254	enables just the iconv* functionality and is now on by default.
1255	WITH_LIBICONV_COMPAT enables the libiconv api and link time
1256	compatibility.  Set WITHOUT_ICONV to build the old way.
1257	If you have been using WITH_ICONV before, you will very likely
1258	need to turn on WITH_LIBICONV_COMPAT.
1259
126020130806:
1261	INVARIANTS option now enables DEBUG for code with OpenSolaris and
1262	Illumos origin, including ZFS.  If you have INVARIANTS in your
1263	kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
1264	explicitly.
1265	DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
1266	locks if WITNESS option was set.  Because that generated a lot of
1267	witness(9) reports and all of them were believed to be false
1268	positives, this is no longer done.  New option OPENSOLARIS_WITNESS
1269	can be used to achieve the previous behavior.
1270
127120130806:
1272	Timer values in IPv6 data structures now use time_uptime instead
1273	of time_second.  Although this is not a user-visible functional
1274	change, userland utilities which directly use them---ndp(8),
1275	rtadvd(8), and rtsold(8) in the base system---need to be updated
1276	to r253970 or later.
1277
127820130802:
1279	find -delete can now delete the pathnames given as arguments,
1280	instead of only files found below them or if the pathname did
1281	not contain any slashes. Formerly, the following error message
1282	would result:
1283
1284	find: -delete: <path>: relative path potentially not safe
1285
1286	Deleting the pathnames given as arguments can be prevented
1287	without error messages using -mindepth 1 or by changing
1288	directory and passing "." as argument to find. This works in the
1289	old as well as the new version of find.
1290
129120130726:
1292	Behavior of devfs rules path matching has been changed.
1293	Pattern is now always matched against fully qualified devfs
1294	path and slash characters must be explicitly matched by
1295	slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
1296	subdirectories must be reviewed.
1297
129820130716:
1299	The default ARM ABI has changed to the ARM EABI. The old ABI is
1300	incompatible with the ARM EABI and all programs and modules will
1301	need to be rebuilt to work with a new kernel.
1302
1303	To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
1304
1305	NOTE: Support for the old ABI will be removed in the future and
1306	users are advised to upgrade.
1307
130820130709:
1309	pkg_install has been disconnected from the build if you really need it
1310	you should add WITH_PKGTOOLS in your src.conf(5).
1311
131220130709:
1313	Most of network statistics structures were changed to be able
1314	keep 64-bits counters. Thus all tools, that work with networking
1315	statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
1316
131720130618:
1318	Fix a bug that allowed a tracing process (e.g. gdb) to write
1319	to a memory-mapped file in the traced process's address space
1320	even if neither the traced process nor the tracing process had
1321	write access to that file.
1322
132320130615:
1324	CVS has been removed from the base system.  An exact copy
1325	of the code is available from the devel/cvs port.
1326
132720130613:
1328	Some people report the following error after the switch to bmake:
1329
1330		make: illegal option -- J
1331		usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
1332			...
1333		*** [buildworld] Error code 2
1334
1335	this likely due to an old instance of make in
1336	${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
1337	which src/Makefile will use that blindly, if it exists, so if
1338	you see the above error:
1339
1340		rm -rf `make -V MAKEPATH`
1341
1342	should resolve it.
1343
134420130516:
1345	Use bmake by default.
1346	Whereas before one could choose to build with bmake via
1347	-DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
1348	make. The goal is to remove these knobs for 10-RELEASE.
1349
1350	It is worth noting that bmake (like gmake) treats the command
1351	line as the unit of failure, rather than statements within the
1352	command line.  Thus '(cd some/where && dosomething)' is safer
1353	than 'cd some/where; dosomething'. The '()' allows consistent
1354	behavior in parallel build.
1355
135620130429:
1357	Fix a bug that allows NFS clients to issue READDIR on files.
1358
135920130426:
1360	The WITHOUT_IDEA option has been removed because
1361	the IDEA patent expired.
1362
136320130426:
1364	The sysctl which controls TRIM support under ZFS has been renamed
1365	from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
1366	enabled by default.
1367
136820130425:
1369	The mergemaster command now uses the default MAKEOBJDIRPREFIX
1370	rather than creating it's own in the temporary directory in
1371	order allow access to bootstrapped versions of tools such as
1372	install and mtree.  When upgrading from version of FreeBSD where
1373	the install command does not support -l, you will need to
1374	install a new mergemaster command if mergemaster -p is required.
1375	This can be accomplished with the command (cd src/usr.sbin/mergemaster
1376	&& make install).
1377
137820130404:
1379	Legacy ATA stack, disabled and replaced by new CAM-based one since
1380	FreeBSD 9.0, completely removed from the sources.  Kernel modules
1381	atadisk and atapi*, user-level tools atacontrol and burncd are
1382	removed.  Kernel option `options ATA_CAM` is now permanently enabled
1383	and removed.
1384
138520130319:
1386	SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
1387	and socketpair(2). Software, in particular Kerberos, may
1388	automatically detect and use these during building. The resulting
1389	binaries will not work on older kernels.
1390
139120130308:
1392	CTL_DISABLE has also been added to the sparc64 GENERIC (for further
1393	information, see the respective 20130304 entry).
1394
139520130304:
1396	Recent commits to callout(9) changed the size of struct callout,
1397	so the KBI is probably heavily disturbed. Also, some functions
1398	in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
1399	by macros. Every kernel module using it won't load, so rebuild
1400	is requested.
1401
1402	The ctl device has been re-enabled in GENERIC for i386 and amd64,
1403	but does not initialize by default (because of the new CTL_DISABLE
1404	option) to save memory.  To re-enable it, remove the CTL_DISABLE
1405	option from the kernel config file or set kern.cam.ctl.disable=0
1406	in /boot/loader.conf.
1407
140820130301:
1409	The ctl device has been disabled in GENERIC for i386 and amd64.
1410	This was done due to the extra memory being allocated at system
1411	initialisation time by the ctl driver which was only used if
1412	a CAM target device was created.  This makes a FreeBSD system
1413	unusable on 128MB or less of RAM.
1414
141520130208:
1416	A new compression method (lz4) has been merged to -HEAD.  Please
1417	refer to zpool-features(7) for more information.
1418
1419	Please refer to the "ZFS notes" section of this file for information
1420	on upgrading boot ZFS pools.
1421
142220130129:
1423	A BSD-licensed patch(1) variant has been added and is installed
1424	as bsdpatch, being the GNU version the default patch.
1425	To inverse the logic and use the BSD-licensed one as default,
1426	while having the GNU version installed as gnupatch, rebuild
1427	and install world with the WITH_BSD_PATCH knob set.
1428
142920130121:
1430	Due to the use of the new -l option to install(1) during build
1431	and install, you must take care not to directly set the INSTALL
1432	make variable in your /etc/make.conf, /etc/src.conf, or on the
1433	command line.  If you wish to use the -C flag for all installs
1434	you may be able to add INSTALL+=-C to /etc/make.conf or
1435	/etc/src.conf.
1436
143720130118:
1438	The install(1) option -M has changed meaning and now takes an
1439	argument that is a file or path to append logs to.  In the
1440	unlikely event that -M was the last option on the command line
1441	and the command line contained at least two files and a target
1442	directory the first file will have logs appended to it.  The -M
1443	option served little practical purpose in the last decade so its
1444	use is expected to be extremely rare.
1445
144620121223:
1447	After switching to Clang as the default compiler some users of ZFS
1448	on i386 systems started to experience stack overflow kernel panics.
1449	Please consider using 'options KSTACK_PAGES=4' in such configurations.
1450
145120121222:
1452	GEOM_LABEL now mangles label names read from file system metadata.
1453	Mangling affect labels containing spaces, non-printable characters,
1454	'%' or '"'. Device names in /etc/fstab and other places may need to
1455	be updated.
1456
145720121217:
1458	By default, only the 10 most recent kernel dumps will be saved.  To
1459	restore the previous behaviour (no limit on the number of kernel dumps
1460	stored in the dump directory) add the following line to /etc/rc.conf:
1461
1462		savecore_flags=""
1463
146420121201:
1465	With the addition of auditdistd(8), a new auditdistd user is now
1466	required during installworld.  "mergemaster -p" can be used to
1467	add the user prior to installworld, as documented in the handbook.
1468
146920121117:
1470	The sin6_scope_id member variable in struct sockaddr_in6 is now
1471	filled by the kernel before passing the structure to the userland via
1472	sysctl or routing socket.  This means the KAME-specific embedded scope
1473	id in sin6_addr.s6_addr[2] is always cleared in userland application.
1474	This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
1475	__FreeBSD_version is bumped to 1000025.
1476
147720121105:
1478	On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
1479	This means that the world and kernel will be compiled with clang
1480	and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
1481	and /usr/bin/cpp.  To disable this behavior and revert to building
1482	with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
1483	of current may need to bootstrap WITHOUT_CLANG first if the clang
1484	build fails (its compatibility window doesn't extend to the 9 stable
1485	branch point).
1486
148720121102:
1488	The IPFIREWALL_FORWARD kernel option has been removed. Its
1489	functionality now turned on by default.
1490
149120121023:
1492	The ZERO_COPY_SOCKET kernel option has been removed and
1493	split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
1494	NB: SOCKET_SEND_COW uses the VM page based copy-on-write
1495	mechanism which is not safe and may result in kernel crashes.
1496	NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
1497	driver supports disposeable external page sized mbuf storage.
1498	Proper replacements for both zero-copy mechanisms are under
1499	consideration and will eventually lead to complete removal
1500	of the two kernel options.
1501
150220121023:
1503	The IPv4 network stack has been converted to network byte
1504	order. The following modules need to be recompiled together
1505	with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
1506	pf(4), ipfw(4), ng_ipfw(4), stf(4).
1507
150820121022:
1509	Support for non-MPSAFE filesystems was removed from VFS. The
1510	VFS_VERSION was bumped, all filesystem modules shall be
1511	recompiled.
1512
151320121018:
1514	All the non-MPSAFE filesystems have been disconnected from
1515	the build. The full list includes: codafs, hpfs, ntfs, nwfs,
1516	portalfs, smbfs, xfs.
1517
151820121016:
1519	The interface cloning API and ABI has changed. The following
1520	modules need to be recompiled together with kernel:
1521	ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
1522	vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
1523	faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
1524
152520121015:
1526	The sdhci driver was split in two parts: sdhci (generic SD Host
1527	Controller logic) and sdhci_pci (actual hardware driver).
1528	No kernel config modifications are required, but if you
1529	load sdhc as a module you must switch to sdhci_pci instead.
1530
153120121014:
1532	Import the FUSE kernel and userland support into base system.
1533
153420121013:
1535	The GNU sort(1) program has been removed since the BSD-licensed
1536	sort(1) has been the default for quite some time and no serious
1537	problems have been reported.  The corresponding WITH_GNU_SORT
1538	knob has also gone.
1539
154020121006:
1541	The pfil(9) API/ABI for AF_INET family has been changed. Packet
1542	filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
1543	with new kernel.
1544
154520121001:
1546	The net80211(4) ABI has been changed to allow for improved driver
1547	PS-POLL and power-save support.  All wireless drivers need to be
1548	recompiled to work with the new kernel.
1549
155020120913:
1551	The random(4) support for the VIA hardware random number
1552	generator (`PADLOCK') is no longer enabled unconditionally.
1553	Add the padlock_rng device in the custom kernel config if
1554	needed.  The GENERIC kernels on i386 and amd64 do include the
1555	device, so the change only affects the custom kernel
1556	configurations.
1557
155820120908:
1559	The pf(4) packet filter ABI has been changed. pfctl(8) and
1560	snmp_pf module need to be recompiled to work with new kernel.
1561
156220120828:
1563	A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
1564	to -HEAD. Pools that have empty_bpobj in active state can not be
1565	imported read-write with ZFS implementations that do not support
1566	this feature. For more information read the zpool-features(5)
1567	manual page.
1568
156920120727:
1570	The sparc64 ZFS loader has been changed to no longer try to auto-
1571	detect ZFS providers based on diskN aliases but now requires these
1572	to be explicitly listed in the OFW boot-device environment variable.
1573
157420120712:
1575	The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
1576	libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
1577	configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
1578
157920120712:
1580	The following sysctls and tunables have been renamed for consistency
1581	with other variables:
1582	  kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
1583	  kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
1584
158520120628:
1586	The sort utility has been replaced with BSD sort.  For now, GNU sort
1587	is also available as "gnusort" or the default can be set back to
1588	GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
1589	installed as "bsdsort".
1590
159120120611:
1592	A new version of ZFS (pool version 5000) has been merged to -HEAD.
1593	Starting with this version the old system of ZFS pool versioning
1594	is superseded by "feature flags". This concept enables forward
1595	compatibility against certain future changes in functionality of ZFS
1596	pools. The first read-only compatible "feature flag" for ZFS pools
1597	is named "com.delphix:async_destroy". For more information
1598	read the new zpool-features(5) manual page.
1599	Please refer to the "ZFS notes" section of this file for information
1600	on upgrading boot ZFS pools.
1601
160220120417:
1603	The malloc(3) implementation embedded in libc now uses sources imported
1604	as contrib/jemalloc.  The most disruptive API change is to
1605	/etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
1606	delete it prior to installworld, and optionally re-create it using the
1607	new format after rebooting.  See malloc.conf(5) for details
1608	(specifically the TUNING section and the "opt.*" entries in the MALLCTL
1609	NAMESPACE section).
1610
161120120328:
1612	Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
1613	is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
1614	now spelled mips.  This is to aid compatibility with third-party
1615	software that expects this naming scheme in uname(3).  Little-endian
1616	settings are unchanged. If you are updating a big-endian mips64 machine
1617	from before this change, you may need to set MACHINE_ARCH=mips64 in
1618	your environment before the new build system will recognize your machine.
1619
162020120306:
1621	Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
1622	platforms.
1623
162420120229:
1625	Now unix domain sockets behave "as expected" on	nullfs(5). Previously
1626	nullfs(5) did not pass through all behaviours to the underlying layer,
1627	as a result if we bound to a socket on the lower layer we could connect
1628	only to the lower path; if we bound to the upper layer we could connect
1629	only to	the upper path. The new behavior is one can connect to both the
1630	lower and the upper paths regardless what layer path one binds to.
1631
163220120211:
1633	The getifaddrs upgrade path broken with 20111215 has been restored.
1634	If you have upgraded in between 20111215 and 20120209 you need to
1635	recompile libc again with your kernel.  You still need to recompile
1636	world to be able to configure CARP but this restriction already
1637	comes from 20111215.
1638
163920120114:
1640	The set_rcvar() function has been removed from /etc/rc.subr.  All
1641	base and ports rc.d scripts have been updated, so if you have a
1642	port installed with a script in /usr/local/etc/rc.d you can either
1643	hand-edit the rcvar= line, or reinstall the port.
1644
1645	An easy way to handle the mass-update of /etc/rc.d:
1646	rm /etc/rc.d/* && mergemaster -i
1647
164820120109:
1649	panic(9) now stops other CPUs in the SMP systems, disables interrupts
1650	on the current CPU and prevents other threads from running.
1651	This behavior can be reverted using the kern.stop_scheduler_on_panic
1652	tunable/sysctl.
1653	The new behavior can be incompatible with kern.sync_on_panic.
1654
165520111215:
1656	The carp(4) facility has been changed significantly. Configuration
1657	of the CARP protocol via ifconfig(8) has changed, as well as format
1658	of CARP events submitted to devd(8) has changed. See manual pages
1659	for more information. The arpbalance feature of carp(4) is currently
1660	not supported anymore.
1661
1662	Size of struct in_aliasreq, struct in6_aliasreq has changed. User
1663	utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
1664	need to be recompiled.
1665
166620111122:
1667	The acpi_wmi(4) status device /dev/wmistat has been renamed to
1668	/dev/wmistat0.
1669
167020111108:
1671	The option VFS_ALLOW_NONMPSAFE option has been added in order to
1672	explicitely support non-MPSAFE filesystems.
1673	It is on by default for all supported platform at this present
1674	time.
1675
167620111101:
1677	The broken amd(4) driver has been replaced with esp(4) in the amd64,
1678	i386 and pc98 GENERIC kernel configuration files.
1679
168020110930:
1681	sysinstall has been removed
1682
168320110923:
1684	The stable/9 branch created in subversion.  This corresponds to the
1685	RELENG_9 branch in CVS.
1686
1687COMMON ITEMS:
1688
1689	General Notes
1690	-------------
1691	Avoid using make -j when upgrading.  While generally safe, there are
1692	sometimes problems using -j to upgrade.  If your upgrade fails with
1693	-j, please try again without -j.  From time to time in the past there
1694	have been problems using -j with buildworld and/or installworld.  This
1695	is especially true when upgrading between "distant" versions (eg one
1696	that cross a major release boundary or several minor releases, or when
1697	several months have passed on the -current branch).
1698
1699	Sometimes, obscure build problems are the result of environment
1700	poisoning.  This can happen because the make utility reads its
1701	environment when searching for values for global variables.  To run
1702	your build attempts in an "environmental clean room", prefix all make
1703	commands with 'env -i '.  See the env(1) manual page for more details.
1704
1705	When upgrading from one major version to another it is generally best to
1706	upgrade to the latest code in the currently installed branch first, then
1707	do an upgrade to the new branch. This is the best-tested upgrade path,
1708	and has the highest probability of being successful.  Please try this
1709	approach if you encounter problems with a major version upgrade.  Since
1710	the stable 4.x branch point, one has generally been able to upgade from
1711	anywhere in the most recent stable branch to head / current (or even the
1712	last couple of stable branches). See the top of this file when there's
1713	an exception.
1714
1715	When upgrading a live system, having a root shell around before
1716	installing anything can help undo problems. Not having a root shell
1717	around can lead to problems if pam has changed too much from your
1718	starting point to allow continued authentication after the upgrade.
1719
1720	This file should be read as a log of events. When a later event changes
1721	information of a prior event, the prior event should not be deleted.
1722	Instead, a pointer to the entry with the new information should be
1723	placed in the old entry. Readers of this file should also sanity check
1724	older entries before relying on them blindly. Authors of new entries
1725	should write them with this in mind.
1726
1727	ZFS notes
1728	---------
1729	When upgrading the boot ZFS pool to a new version, always follow
1730	these two steps:
1731
1732	1.) recompile and reinstall the ZFS boot loader and boot block
1733	(this is part of "make buildworld" and "make installworld")
1734
1735	2.) update the ZFS boot block on your boot drive
1736
1737	The following example updates the ZFS boot block on the first
1738	partition (freebsd-boot) of a GPT partitioned drive ada0:
1739	"gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
1740
1741	Non-boot pools do not need these updates.
1742
1743	To build a kernel
1744	-----------------
1745	If you are updating from a prior version of FreeBSD (even one just
1746	a few days old), you should follow this procedure.  It is the most
1747	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1748
1749	make kernel-toolchain
1750	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1751	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1752
1753	To test a kernel once
1754	---------------------
1755	If you just want to boot a kernel once (because you are not sure
1756	if it works, or if you want to boot a known bad kernel to provide
1757	debugging information) run
1758	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1759	nextboot -k testkernel
1760
1761	To just build a kernel when you know that it won't mess you up
1762	--------------------------------------------------------------
1763	This assumes you are already running a CURRENT system.  Replace
1764	${arch} with the architecture of your machine (e.g. "i386",
1765	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
1766
1767	cd src/sys/${arch}/conf
1768	config KERNEL_NAME_HERE
1769	cd ../compile/KERNEL_NAME_HERE
1770	make depend
1771	make
1772	make install
1773
1774	If this fails, go to the "To build a kernel" section.
1775
1776	To rebuild everything and install it on the current system.
1777	-----------------------------------------------------------
1778	# Note: sometimes if you are running current you gotta do more than
1779	# is listed here if you are upgrading from a really old current.
1780
1781	<make sure you have good level 0 dumps>
1782	make buildworld
1783	make kernel KERNCONF=YOUR_KERNEL_HERE
1784							[1]
1785	<reboot in single user>				[3]
1786	mergemaster -Fp					[5]
1787	make installworld
1788	mergemaster -Fi					[4]
1789	make delete-old					[6]
1790	<reboot>
1791
1792	To cross-install current onto a separate partition
1793	--------------------------------------------------
1794	# In this approach we use a separate partition to hold
1795	# current's root, 'usr', and 'var' directories.   A partition
1796	# holding "/", "/usr" and "/var" should be about 2GB in
1797	# size.
1798
1799	<make sure you have good level 0 dumps>
1800	<boot into -stable>
1801	make buildworld
1802	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1803	<maybe newfs current's root partition>
1804	<mount current's root partition on directory ${CURRENT_ROOT}>
1805	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
1806	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1807	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1808	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
1809	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1810	<reboot into current>
1811	<do a "native" rebuild/install as described in the previous section>
1812	<maybe install compatibility libraries from ports/misc/compat*>
1813	<reboot>
1814
1815
1816	To upgrade in-place from stable to current
1817	----------------------------------------------
1818	<make sure you have good level 0 dumps>
1819	make buildworld					[9]
1820	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
1821							[1]
1822	<reboot in single user>				[3]
1823	mergemaster -Fp					[5]
1824	make installworld
1825	mergemaster -Fi					[4]
1826	make delete-old					[6]
1827	<reboot>
1828
1829	Make sure that you've read the UPDATING file to understand the
1830	tweaks to various things you need.  At this point in the life
1831	cycle of current, things change often and you are on your own
1832	to cope.  The defaults can also change, so please read ALL of
1833	the UPDATING entries.
1834
1835	Also, if you are tracking -current, you must be subscribed to
1836	freebsd-current@freebsd.org.  Make sure that before you update
1837	your sources that you have read and understood all the recent
1838	messages there.  If in doubt, please track -stable which has
1839	much fewer pitfalls.
1840
1841	[1] If you have third party modules, such as vmware, you
1842	should disable them at this point so they don't crash your
1843	system on reboot.
1844
1845	[3] From the bootblocks, boot -s, and then do
1846		fsck -p
1847		mount -u /
1848		mount -a
1849		cd src
1850		adjkerntz -i		# if CMOS is wall time
1851	Also, when doing a major release upgrade, it is required that
1852	you boot into single user mode to do the installworld.
1853
1854	[4] Note: This step is non-optional.  Failure to do this step
1855	can result in a significant reduction in the functionality of the
1856	system.  Attempting to do it by hand is not recommended and those
1857	that pursue this avenue should read this file carefully, as well
1858	as the archives of freebsd-current and freebsd-hackers mailing lists
1859	for potential gotchas.  The -U option is also useful to consider.
1860	See mergemaster(8) for more information.
1861
1862	[5] Usually this step is a noop.  However, from time to time
1863	you may need to do this if you get unknown user in the following
1864	step.  It never hurts to do it all the time.  You may need to
1865	install a new mergemaster (cd src/usr.sbin/mergemaster && make
1866	install) after the buildworld before this step if you last updated
1867	from current before 20130425 or from -stable before 20130430.
1868
1869	[6] This only deletes old files and directories. Old libraries
1870	can be deleted by "make delete-old-libs", but you have to make
1871	sure that no program is using those libraries anymore.
1872
1873	[8] In order to have a kernel that can run the 4.x binaries needed to
1874	do an installworld, you must include the COMPAT_FREEBSD4 option in
1875	your kernel.  Failure to do so may leave you with a system that is
1876	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1877	required to run the 5.x binaries on more recent kernels.  And so on
1878	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1879
1880	Make sure that you merge any new devices from GENERIC since the
1881	last time you updated your kernel config file.
1882
1883	[9] When checking out sources, you must include the -P flag to have
1884	cvs prune empty directories.
1885
1886	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1887	"?=" instead of the "=" assignment operator, so that buildworld can
1888	override the CPUTYPE if it needs to.
1889
1890	MAKEOBJDIRPREFIX must be defined in an environment variable, and
1891	not on the command line, or in /etc/make.conf.  buildworld will
1892	warn if it is improperly defined.
1893FORMAT:
1894
1895This file contains a list, in reverse chronological order, of major
1896breakages in tracking -current.  It is not guaranteed to be a complete
1897list of such breakages, and only contains entries since September 23, 2011.
1898If you need to see UPDATING entries from before that date, you will need
1899to fetch an UPDATING file from an older FreeBSD release.
1900
1901Copyright information:
1902
1903Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1904
1905Redistribution, publication, translation and use, with or without
1906modification, in full or in part, in any form or format of this
1907document are permitted without further permission from the author.
1908
1909THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1910IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1911WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1912DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1913INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1914(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1915SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1916HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1917STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1918IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1919POSSIBILITY OF SUCH DAMAGE.
1920
1921Contact Warner Losh if you have any questions about your use of
1922this document.
1923
1924$FreeBSD$
1925