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