xref: /freebsd/UPDATING (revision 65b71c48d226f3ef3eb1c4452dccc678a7d2ac96)
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    http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
10
11Items affecting the ports and packages system can be found in
12/usr/ports/UPDATING.  Please read that file before running portupgrade.
13
14NOTE: FreeBSD has switched from gcc to clang. If you have trouble bootstrapping
15from older versions of FreeBSD, try WITHOUT_CLANG and WITH_GCC to bootstrap to
16the tip of head, and then rebuild without this option. The bootstrap process from
17older version of current across the gcc/clang cutover is a bit fragile.
18
19NOTE TO PEOPLE WHO THINK THAT FreeBSD 11.x IS SLOW:
20	FreeBSD 11.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
3420150924:
35	Kernel debug files have been moved to /usr/lib/debug/boot/kernel/,
36	and renamed from .symbols to .debug. This reduces the size requirements
37	on the boot partition or file system and provides consistency with
38	userland debug files.
39
40	When using the supported kernel installation method the
41	/usr/lib/debug/boot/kernel directory will be renamed (to kernel.old)
42	as is done with /boot/kernel.
43
44	Developers wishing to maintain the historical behavior of installing
45	debug files in /boot/kernel/ can set KERN_DEBUGDIR="" in src.conf(5).
46
4720150827:
48	The wireless drivers had undergone changes that remove the 'parent
49	interface' from the ifconfig -l output. The rc.d network scripts
50	used to check presence of a parent interface in the list, so old
51	scripts would fail to start wireless networking. Thus, etcupdate(3)
52	or mergemaster(8) run is required after kernel update, to update your
53	rc.d scripts in /etc.
54
5520150827:
56	pf no longer supports 'scrub fragment crop' or 'scrub fragment drop-ovl'
57	These configurations are now automatically interpreted as
58	'scrub fragment reassemble'.
59
6020150817:
61	Kernel-loadable modules for the random(4) device are back. To use
62	them, the kernel must have
63
64	device	random
65	options	RANDOM_LOADABLE
66
67	kldload(8) can then be used to load random_fortuna.ko
68	or random_yarrow.ko. Please note that due to the indirect
69	function calls that the loadable modules need to provide,
70	the build-in variants will be slightly more efficient.
71
72	The random(4) kernel option RANDOM_DUMMY has been retired due to
73	unpopularity. It was not all that useful anyway.
74
7520150813:
76	The WITHOUT_ELFTOOLCHAIN_TOOLS src.conf(5) knob has been retired.
77	Control over building the ELF Tool Chain tools is now provided by
78	the WITHOUT_TOOLCHAIN knob.
79
8020150810:
81	The polarity of Pulse Per Second (PPS) capture events with the
82	uart(4) driver has been corrected.  Prior to this change the PPS
83	"assert" event corresponded to the trailing edge of a positive PPS
84	pulse and the "clear" event was the leading edge of the next pulse.
85
86	As the width of a PPS pulse in a typical GPS receiver is on the
87	order of 1 millisecond, most users will not notice any significant
88	difference with this change.
89
90	Anyone who has compensated for the historical polarity reversal by
91	configuring a negative offset equal to the pulse width will need to
92	remove that workaround.
93
9420150809:
95	The default group assigned to /dev/dri entries has been changed
96	from 'wheel' to 'video' with the id of '44'. If you want to have
97	access to the dri devices please add yourself to the video group
98	with:
99
100	# pw groupmod video -m $USER
101
10220150806:
103	The menu.rc and loader.rc files will now be replaced during
104	upgrades. Please migrate local changes to menu.rc.local and
105	loader.rc.local instead.
106
10720150805:
108	GNU Binutils versions of addr2line, c++filt, nm, readelf, size,
109	strings and strip have been removed. The src.conf(5) knob
110	WITHOUT_ELFTOOLCHAIN_TOOLS no longer provides the binutils tools.
111
11220150728:
113	As ZFS requires more kernel stack pages than is the default on some
114	architectures e.g. i386, it now warns if KSTACK_PAGES is less than
115	ZFS_MIN_KSTACK_PAGES (which is 4 at the time of writing).
116
117	Please consider using 'options KSTACK_PAGES=X' where X is greater
118	than or equal to ZFS_MIN_KSTACK_PAGES i.e. 4 in such configurations.
119
12020150706:
121	sendmail has been updated to 8.15.2.  Starting with FreeBSD 11.0
122	and sendmail 8.15, sendmail uses uncompressed IPv6 addresses by
123	default, i.e., they will not contain "::".  For example, instead
124	of ::1, it will be 0:0:0:0:0:0:0:1.  This permits a zero subnet
125	to have a more specific match, such as different map entries for
126	IPv6:0:0 vs IPv6:0.  This change requires that configuration
127	data (including maps, files, classes, custom ruleset, etc.) must
128	use the same format, so make certain such configuration data is
129	upgrading.  As a very simple check search for patterns like
130	'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'.  To return to the old
131	behavior, set the m4 option confUSE_COMPRESSED_IPV6_ADDRESSES or
132	the cf option UseCompressedIPv6Addresses.
133
13420150630:
135	The default kernel entropy-processing algorithm is now
136	Fortuna, replacing Yarrow.
137
138	Assuming you have 'device random' in your kernel config
139	file, the configurations allow a kernel option to override
140	this default. You may choose *ONE* of:
141
142	options	RANDOM_YARROW	# Legacy /dev/random algorithm.
143	options	RANDOM_DUMMY	# Blocking-only driver.
144
145	If you have neither, you get Fortuna.  For most people,
146	read no further, Fortuna will give a /dev/random that works
147	like it always used to, and the difference will be irrelevant.
148
149	If you remove 'device random', you get *NO* kernel-processed
150	entopy at all. This may be acceptable to folks building
151	embedded systems, but has complications. Carry on reading,
152	and it is assumed you know what you need.
153
154	*PLEASE* read random(4) and random(9) if you are in the
155	habit of tweeking kernel configs, and/or if you are a member
156	of the embedded community, wanting specific and not-usual
157	behaviour from your security subsystems.
158
159	NOTE!! If you use RANDOM_DUMMY and/or have no 'device
160	random', you will NOT have a functioning /dev/random, and
161	many cryptographic features will not work, including SSH.
162	You may also find strange behaviour from the random(3) set
163	of library functions, in particular sranddev(3), srandomdev(3)
164	and arc4random(3). The reason for this is that the KERN_ARND
165	sysctl only returns entropy if it thinks it has some to
166	share, and with RANDOM_DUMMY or no 'device random' this
167	will never happen.
168
16920150623:
170	An additional fix for the issue described in the 20150614 sendmail
171	entry below has been been committed in revision 284717.
172
17320150616:
174	FreeBSD's old make (fmake) has been removed from the system. It is
175	available as the devel/fmake port or via pkg install fmake.
176
17720150615:
178	The fix for the issue described in the 20150614 sendmail entry
179	below has been been committed in revision 284436.  The work
180	around described in that entry is no longer needed unless the
181	default setting is overridden by a confDH_PARAMETERS configuration
182	setting of '5' or pointing to a 512 bit DH parameter file.
183
18420150614:
185	ALLOW_DEPRECATED_ATF_TOOLS/ATFFILE support has been removed from
186	atf.test.mk (included from bsd.test.mk). Please upgrade devel/atf
187	and devel/kyua to version 0.20+ and adjust any calling code to work
188	with Kyuafile and kyua.
189
19020150614:
191	The import of openssl to address the FreeBSD-SA-15:10.openssl
192	security advisory includes a change which rejects handshakes
193	with DH parameters below 768 bits.  sendmail releases prior
194	to 8.15.2 (not yet released), defaulted to a 512 bit
195	DH parameter setting for client connections.  To work around
196	this interoperability, sendmail can be configured to use a
197	2048 bit DH parameter by:
198
199	1. Edit /etc/mail/`hostname`.mc
200	2. If a setting for confDH_PARAMETERS does not exist or
201	   exists and is set to a string beginning with '5',
202	   replace it with '2'.
203	3. If a setting for confDH_PARAMETERS exists and is set to
204	   a file path, create a new file with:
205		openssl dhparam -out /path/to/file 2048
206	4. Rebuild the .cf file:
207		cd /etc/mail/; make; make install
208	5. Restart sendmail:
209		cd /etc/mail/; make restart
210
211	A sendmail patch is coming, at which time this file will be
212	updated.
213
21420150604:
215	Generation of legacy formatted entries have been disabled by default
216	in pwd_mkdb(8), as all base system consumers of the legacy formatted
217	entries were converted to use the new format by default when the new,
218	machine independent format have been added and supported since FreeBSD
219	5.x.
220
221	Please see the pwd_mkdb(8) manual page for further details.
222
22320150525:
224	Clang and llvm have been upgraded to 3.6.1 release.  Please see the
225	20141231 entry below for information about prerequisites and upgrading,
226	if you are not already using 3.5.0 or higher.
227
22820150521:
229	TI platform code switched to using vendor DTS files and this update
230	may break existing systems running on Beaglebone, Beaglebone Black,
231	and Pandaboard:
232
233	- dtb files should be regenerated/reinstalled. Filenames are the
234	  same but content is different now
235	- GPIO addressing was changed, now each GPIO bank (32 pins per bank)
236	  has its own /dev/gpiocX device, e.g. pin 121 on /dev/gpioc0 in old
237	  addressing scheme is now pin 25 on /dev/gpioc3.
238	- Pandaboard: /etc/ttys should be updated, serial console device is
239	  now /dev/ttyu2, not /dev/ttyu0
240
24120150501:
242	soelim(1) from gnu/usr.bin/groff has been replaced by usr.bin/soelim.
243	If you need the GNU extension from groff soelim(1), install groff
244	from package: pkg install groff, or via ports: textproc/groff.
245
24620150423:
247	chmod, chflags, chown and chgrp now affect symlinks in -R mode as
248	defined in symlink(7); previously symlinks were silently ignored.
249
25020150415:
251	The const qualifier has been removed from iconv(3) to comply with
252	POSIX.  The ports tree is aware of this from r384038 onwards.
253
25420150416:
255	Libraries specified by LIBADD in Makefiles must have a corresponding
256	DPADD_<lib> variable to ensure correct dependencies.  This is now
257	enforced in src.libnames.mk.
258
25920150324:
260	From legacy ata(4) driver was removed support for SATA controllers
261	supported by more functional drivers ahci(4), siis(4) and mvs(4).
262	Kernel modules ataahci and ataadaptec were removed completely,
263	replaced by ahci and mvs modules respectively.
264
26520150315:
266	Clang, llvm and lldb have been upgraded to 3.6.0 release.  Please see
267	the 20141231 entry below for information about prerequisites and
268	upgrading, if you are not already using 3.5.0 or higher.
269
27020150307:
271	The 32-bit PowerPC kernel has been changed to a position-independent
272	executable. This can only be booted with a version of loader(8)
273	newer than January 31, 2015, so make sure to update both world and
274	kernel before rebooting.
275
27620150217:
277	If you are running a -CURRENT kernel since r273872 (Oct 30th, 2014),
278	but before r278950, the RNG was not seeded properly.  Immediately
279	upgrade the kernel to r278950 or later and regenerate any keys (e.g.
280	ssh keys or openssl keys) that were generated w/ a kernel from that
281	range.  This does not affect programs that directly used /dev/random
282	or /dev/urandom.  All userland uses of arc4random(3) are affected.
283
28420150210:
285	The autofs(4) ABI was changed in order to restore binary compatibility
286	with 10.1-RELEASE.  The automountd(8) daemon needs to be rebuilt to work
287	with the new kernel.
288
28920150131:
290	The powerpc64 kernel has been changed to a position-independent
291	executable. This can only be booted with a new version of loader(8),
292	so make sure to update both world and kernel before rebooting.
293
29420150118:
295	Clang and llvm have been upgraded to 3.5.1 release.  This is a bugfix
296	only release, no new features have been added.  Please see the 20141231
297	entry below for information about prerequisites and upgrading, if you
298	are not already using 3.5.0.
299
30020150107:
301	ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
302	taken from the ELF Tool Chain project rather than GNU binutils. They
303	should be drop-in replacements, with the addition of arm64 support.
304	The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
305	binutils tools, if necessary. See 20150805 for updated information.
306
30720150105:
308	The default Unbound configuration now enables remote control
309	using a local socket.  Users who have already enabled the
310	local_unbound service should regenerate their configuration
311	by running "service local_unbound setup" as root.
312
31320150102:
314	The GNU texinfo and GNU info pages have been removed.
315	To be able to view GNU info pages please install texinfo from ports.
316
31720141231:
318	Clang, llvm and lldb have been upgraded to 3.5.0 release.
319
320	As of this release, a prerequisite for building clang, llvm and lldb is
321	a C++11 capable compiler and C++11 standard library.  This means that to
322	be able to successfully build the cross-tools stage of buildworld, with
323	clang as the bootstrap compiler, your system compiler or cross compiler
324	should either be clang 3.3 or later, or gcc 4.8 or later, and your
325	system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
326	later.
327
328	On any standard FreeBSD 10.x or 11.x installation, where clang and
329	libc++ are on by default (that is, on x86 or arm), this should work out
330	of the box.
331
332	On 9.x installations where clang is enabled by default, e.g. on x86 and
333	powerpc, libc++ will not be enabled by default, so libc++ should be
334	built (with clang) and installed first.  If both clang and libc++ are
335	missing, build clang first, then use it to build libc++.
336
337	On 8.x and earlier installations, upgrade to 9.x first, and then follow
338	the instructions for 9.x above.
339
340	Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
341	default, and do not build clang.
342
343	Many embedded systems are resource constrained, and will not be able to
344	build clang in a reasonable time, or in some cases at all.  In those
345	cases, cross building bootable systems on amd64 is a workaround.
346
347	This new version of clang introduces a number of new warnings, of which
348	the following are most likely to appear:
349
350	-Wabsolute-value
351
352	This warns in two cases, for both C and C++:
353	* When the code is trying to take the absolute value of an unsigned
354	  quantity, which is effectively a no-op, and almost never what was
355	  intended.  The code should be fixed, if at all possible.  If you are
356	  sure that the unsigned quantity can be safely cast to signed, without
357	  loss of information or undefined behavior, you can add an explicit
358	  cast, or disable the warning.
359
360	* When the code is trying to take an absolute value, but the called
361	  abs() variant is for the wrong type, which can lead to truncation.
362	  If you want to disable the warning instead of fixing the code, please
363	  make sure that truncation will not occur, or it might lead to unwanted
364	  side-effects.
365
366	-Wtautological-undefined-compare and
367	-Wundefined-bool-conversion
368
369	These warn when C++ code is trying to compare 'this' against NULL, while
370	'this' should never be NULL in well-defined C++ code.  However, there is
371	some legacy (pre C++11) code out there, which actively abuses this
372	feature, which was less strictly defined in previous C++ versions.
373
374	Squid and openjdk do this, for example.  The warning can be turned off
375	for C++98 and earlier, but compiling the code in C++11 mode might result
376	in unexpected behavior; for example, the parts of the program that are
377	unreachable could be optimized away.
378
37920141222:
380	The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
381	kernel sources have been removed. The .h files remain, since some
382	utilities include them. This will need to be fixed later.
383	If "mount -t oldnfs ..." is attempted, it will fail.
384	If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
385	the utilities will report errors.
386
38720141121:
388	The handling of LOCAL_LIB_DIRS has been altered to skip addition of
389	directories to top level SUBDIR variable when their parent
390	directory is included in LOCAL_DIRS.  Users with build systems with
391	such hierarchies and without SUBDIR entries in the parent
392	directory Makefiles should add them or add the directories to
393	LOCAL_DIRS.
394
39520141109:
396	faith(4) and faithd(8) have been removed from the base system. Faith
397	has been obsolete for a very long time.
398
39920141104:
400	vt(4), the new console driver, is enabled by default. It brings
401	support for Unicode and double-width characters, as well as
402	support for UEFI and integration with the KMS kernel video
403	drivers.
404
405	You may need to update your console settings in /etc/rc.conf,
406	most probably the keymap. During boot, /etc/rc.d/syscons will
407	indicate what you need to do.
408
409	vt(4) still has issues and lacks some features compared to
410	syscons(4). See the wiki for up-to-date information:
411	  https://wiki.freebsd.org/Newcons
412
413	If you want to keep using syscons(4), you can do so by adding
414	the following line to /boot/loader.conf:
415	  kern.vty=sc
416
41720141102:
418	pjdfstest has been integrated into kyua as an opt-in test suite.
419	Please see share/doc/pjdfstest/README for more details on how to
420	execute it.
421
42220141009:
423	gperf has been removed from the base system for architectures
424	that use clang. Ports that require gperf will obtain it from the
425	devel/gperf port.
426
42720140923:
428	pjdfstest has been moved from tools/regression/pjdfstest to
429	contrib/pjdfstest .
430
43120140922:
432	At svn r271982, The default linux compat kernel ABI has been adjusted
433	to 2.6.18 in support of the linux-c6 compat ports infrastructure
434	update.  If you wish to continue using the linux-f10 compat ports,
435	add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
436	encouraged to update their linux-compat packages to linux-c6 during
437	their next update cycle.
438
43920140729:
440	The ofwfb driver, used to provide a graphics console on PowerPC when
441	using vt(4), no longer allows mmap() of all physical memory. This
442	will prevent Xorg on PowerPC with some ATI graphics cards from
443	initializing properly unless x11-servers/xorg-server is updated to
444	1.12.4_8 or newer.
445
44620140723:
447	The xdev targets have been converted to using TARGET and
448	TARGET_ARCH instead of XDEV and XDEV_ARCH.
449
45020140719:
451	The default unbound configuration has been modified to address
452	issues with reverse lookups on networks that use private
453	address ranges.  If you use the local_unbound service, run
454	"service local_unbound setup" as root to regenerate your
455	configuration, then "service local_unbound reload" to load the
456	new configuration.
457
45820140709:
459	The GNU texinfo and GNU info pages are not built and installed
460	anymore, WITH_INFO knob has been added to allow to built and install
461	them again.
462	UPDATE: see 20150102 entry on texinfo's removal
463
46420140708:
465	The GNU readline library is now an INTERNALLIB - that is, it is
466	statically linked into consumers (GDB and variants) in the base
467	system, and the shared library is no longer installed.  The
468	devel/readline port is available for third party software that
469	requires readline.
470
47120140702:
472	The Itanium architecture (ia64) has been removed from the list of
473	known architectures. This is the first step in the removal of the
474	architecture.
475
47620140701:
477	Commit r268115 has added NFSv4.1 server support, merged from
478	projects/nfsv4.1-server.  Since this includes changes to the
479	internal interfaces between the NFS related modules, a full
480	build of the kernel and modules will be necessary.
481	__FreeBSD_version has been bumped.
482
48320140629:
484	The WITHOUT_VT_SUPPORT kernel config knob has been renamed
485	WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
486	which differs from the behaviour controlled by this knob.)
487
48820140619:
489	Maximal length of the serial number in CTL was increased from 16 to
490	64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
491	and ctld, need to be rebuilt to work with a new kernel.
492
49320140606:
494	The libatf-c and libatf-c++ major versions were downgraded to 0 and
495	1 respectively to match the upstream numbers.  They were out of
496	sync because, when they were originally added to FreeBSD, the
497	upstream versions were not respected.  These libraries are private
498	and not yet built by default, so renumbering them should be a
499	non-issue.  However, unclean source trees will yield broken test
500	programs once the operator executes "make delete-old-libs" after a
501	"make installworld".
502
503	Additionally, the atf-sh binary was made private by moving it into
504	/usr/libexec/.  Already-built shell test programs will keep the
505	path to the old binary so they will break after "make delete-old"
506	is run.
507
508	If you are using WITH_TESTS=yes (not the default), wipe the object
509	tree and rebuild from scratch to prevent spurious test failures.
510	This is only needed once: the misnumbered libraries and misplaced
511	binaries have been added to OptionalObsoleteFiles.inc so they will
512	be removed during a clean upgrade.
513
51420140512:
515	Clang and llvm have been upgraded to 3.4.1 release.
516
51720140508:
518	We bogusly installed src.opts.mk in /usr/share/mk. This file should
519	be removed to avoid issues in the future (and has been added to
520	ObsoleteFiles.inc).
521
52220140505:
523	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
524	past, it affected all builds that used the bsd.*.mk files. The old
525	behavior was a bug, but people may have relied upon it. To get this
526	behavior back, you can .include /etc/src.conf from /etc/make.conf
527	(which is still global and isn't changed). This also changes the
528	behavior of incremental builds inside the tree of individual
529	directories. Set MAKESYSPATH to ".../share/mk" to do that.
530	Although this has survived make universe and some upgrade scenarios,
531	other upgrade scenarios may have broken. At least one form of
532	temporary breakage was fixed with MAKESYSPATH settings for buildworld
533	as well... In cases where MAKESYSPATH isn't working with this
534	setting, you'll need to set it to the full path to your tree.
535
536	One side effect of all this cleaning up is that bsd.compiler.mk
537	is no longer implicitly included by bsd.own.mk. If you wish to
538	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
539	as well.
540
54120140430:
542	The lindev device has been removed since /dev/full has been made a
543	standard device.  __FreeBSD_version has been bumped.
544
54520140424:
546	The knob WITHOUT_VI was added to the base system, which controls
547	building ex(1), vi(1), etc. Older releases of FreeBSD required ex(1)
548	in order to reorder files share/termcap and didn't build ex(1) as a
549	build tool, so building/installing with WITH_VI is highly advised for
550	build hosts for older releases.
551
552	This issue has been fixed in stable/9 and stable/10 in r277022 and
553	r276991, respectively.
554
55520140418:
556	The YES_HESIOD knob has been removed. It has been obsolete for
557	a decade. Please move to using WITH_HESIOD instead or your builds
558	will silently lack HESIOD.
559
56020140405:
561	The uart(4) driver has been changed with respect to its handling
562	of the low-level console. Previously the uart(4) driver prevented
563	any process from changing the baudrate or the CLOCAL and HUPCL
564	control flags. By removing the restrictions, operators can make
565	changes to the serial console port without having to reboot.
566	However, when getty(8) is started on the serial device that is
567	associated with the low-level console, a misconfigured terminal
568	line in /etc/ttys will now have a real impact.
569	Before upgrading the kernel, make sure that /etc/ttys has the
570	serial console device configured as 3wire without baudrate to
571	preserve the previous behaviour. E.g:
572	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
573
57420140306:
575	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
576	to improve performance.  To re-enable it, if needed, run rpcbind
577	with command line option -W.
578
57920140226:
580	Switched back to the GPL dtc compiler due to updates in the upstream
581	dts files not being supported by the BSDL dtc compiler. You will need
582	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
583	may result while building dtb files during a kernel build if you fail
584	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
585
58620140216:
587	Clang and llvm have been upgraded to 3.4 release.
588
58920140216:
590	The nve(4) driver has been removed.  Please use the nfe(4) driver
591	for NVIDIA nForce MCP Ethernet adapters instead.
592
59320140212:
594	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
595	This could cause certain C++ applications using shared libraries built
596	against the previous version of libc++ to crash.  The incompatibility
597	has now been fixed, but any C++ applications or shared libraries built
598	between r261283 and r261801 should be recompiled.
599
60020140204:
601	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
602	capability mode support.  Please note that enabling the feature in
603	kernel is still highly recommended.
604
60520140131:
606	OpenSSH is now built with sandbox support, and will use sandbox as
607	the default privilege separation method.  This requires Capsicum
608	capability mode support in kernel.
609
61020140128:
611	The libelf and libdwarf libraries have been updated to newer
612	versions from upstream. Shared library version numbers for
613	these two libraries were bumped. Any ports or binaries
614	requiring these two libraries should be recompiled.
615	__FreeBSD_version is bumped to 1100006.
616
61720140110:
618	If a Makefile in a tests/ directory was auto-generating a Kyuafile
619	instead of providing an explicit one, this would prevent such
620	Makefile from providing its own Kyuafile in the future during
621	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
622	intervention is needed to clean an objdir if you use NO_CLEAN:
623	  # find /usr/obj -name Kyuafile | xargs rm -f
624
62520131213:
626	The behavior of gss_pseudo_random() for the krb5 mechanism
627	has changed, for applications requesting a longer random string
628	than produced by the underlying enctype's pseudo-random() function.
629	In particular, the random string produced from a session key of
630	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
631	be different at the 17th octet and later, after this change.
632	The counter used in the PRF+ construction is now encoded as a
633	big-endian integer in accordance with RFC 4402.
634	__FreeBSD_version is bumped to 1100004.
635
63620131108:
637	The WITHOUT_ATF build knob has been removed and its functionality
638	has been subsumed into the more generic WITHOUT_TESTS.  If you were
639	using the former to disable the build of the ATF libraries, you
640	should change your settings to use the latter.
641
64220131025:
643	The default version of mtree is nmtree which is obtained from
644	NetBSD.  The output is generally the same, but may vary
645	slightly.  If you found you need identical output adding
646	"-F freebsd9" to the command line should do the trick.  For the
647	time being, the old mtree is available as fmtree.
648
64920131014:
650	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
651	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
652	1.1.4_8 and verify bsdyml not linked in, before running "make
653	delete-old-libs":
654	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
655	  or
656	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
657
65820131010:
659	The stable/10 branch has been created in subversion from head
660	revision r256279.
661
66220131010:
663	The rc.d/jail script has been updated to support jail(8)
664	configuration file.  The "jail_<jname>_*" rc.conf(5) variables
665	for per-jail configuration are automatically converted to
666	/var/run/jail.<jname>.conf before the jail(8) utility is invoked.
667	This is transparently backward compatible.  See below about some
668	incompatibilities and rc.conf(5) manual page for more details.
669
670	These variables are now deprecated in favor of jail(8) configuration
671	file.  One can use "rc.d/jail config <jname>" command to generate
672	a jail(8) configuration file in /var/run/jail.<jname>.conf without
673	running the jail(8) utility.   The default pathname of the
674	configuration file is /etc/jail.conf and can be specified by
675	using $jail_conf or $jail_<jname>_conf variables.
676
677	Please note that jail_devfs_ruleset accepts an integer at
678	this moment.  Please consider to rewrite the ruleset name
679	with an integer.
680
68120130930:
682	BIND has been removed from the base system.  If all you need
683	is a local resolver, simply enable and start the local_unbound
684	service instead.  Otherwise, several versions of BIND are
685	available in the ports tree.   The dns/bind99 port is one example.
686
687	With this change, nslookup(1) and dig(1) are no longer in the base
688	system.  Users should instead use host(1) and drill(1) which are
689	in the base system.  Alternatively, nslookup and dig can
690	be obtained by installing the dns/bind-tools port.
691
69220130916:
693	With the addition of unbound(8), a new unbound user is now
694	required during installworld.  "mergemaster -p" can be used to
695	add the user prior to installworld, as documented in the handbook.
696
69720130911:
698	OpenSSH is now built with DNSSEC support, and will by default
699	silently trust signed SSHFP records.  This can be controlled with
700	the VerifyHostKeyDNS client configuration setting.  DNSSEC support
701	can be disabled entirely with the WITHOUT_LDNS option in src.conf.
702
70320130906:
704	The GNU Compiler Collection and C++ standard library (libstdc++)
705	are no longer built by default on platforms where clang is the system
706	compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
707	options in src.conf.
708
70920130905:
710	The PROCDESC kernel option is now part of the GENERIC kernel
711	configuration and is required for the rwhod(8) to work.
712	If you are using custom kernel configuration, you should include
713	'options PROCDESC'.
714
71520130905:
716	The API and ABI related to the Capsicum framework was modified
717	in backward incompatible way. The userland libraries and programs
718	have to be recompiled to work with the new kernel. This includes the
719	following libraries and programs, but the whole buildworld is
720	advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
721	kdump, procstat, rwho, rwhod, uniq.
722
72320130903:
724	AES-NI intrinsic support has been added to gcc.  The AES-NI module
725	has been updated to use this support.  A new gcc is required to build
726	the aesni module on both i386 and amd64.
727
72820130821:
729	The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
730	Thus "device padlock_rng" and "device rdrand_rng" should be
731	used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
732
73320130813:
734	WITH_ICONV has been split into two feature sets.  WITH_ICONV now
735	enables just the iconv* functionality and is now on by default.
736	WITH_LIBICONV_COMPAT enables the libiconv api and link time
737	compatability.  Set WITHOUT_ICONV to build the old way.
738	If you have been using WITH_ICONV before, you will very likely
739	need to turn on WITH_LIBICONV_COMPAT.
740
74120130806:
742	INVARIANTS option now enables DEBUG for code with OpenSolaris and
743	Illumos origin, including ZFS.  If you have INVARIANTS in your
744	kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
745	explicitly.
746	DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
747	locks if WITNESS option was set.  Because that generated a lot of
748	witness(9) reports and all of them were believed to be false
749	positives, this is no longer done.  New option OPENSOLARIS_WITNESS
750	can be used to achieve the previous behavior.
751
75220130806:
753	Timer values in IPv6 data structures now use time_uptime instead
754	of time_second.  Although this is not a user-visible functional
755	change, userland utilities which directly use them---ndp(8),
756	rtadvd(8), and rtsold(8) in the base system---need to be updated
757	to r253970 or later.
758
75920130802:
760	find -delete can now delete the pathnames given as arguments,
761	instead of only files found below them or if the pathname did
762	not contain any slashes. Formerly, the following error message
763	would result:
764
765	find: -delete: <path>: relative path potentially not safe
766
767	Deleting the pathnames given as arguments can be prevented
768	without error messages using -mindepth 1 or by changing
769	directory and passing "." as argument to find. This works in the
770	old as well as the new version of find.
771
77220130726:
773	Behavior of devfs rules path matching has been changed.
774	Pattern is now always matched against fully qualified devfs
775	path and slash characters must be explicitly matched by
776	slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
777	subdirectories must be reviewed.
778
77920130716:
780	The default ARM ABI has changed to the ARM EABI. The old ABI is
781	incompatible with the ARM EABI and all programs and modules will
782	need to be rebuilt to work with a new kernel.
783
784	To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
785
786	NOTE: Support for the old ABI will be removed in the future and
787	users are advised to upgrade.
788
78920130709:
790	pkg_install has been disconnected from the build if you really need it
791	you should add WITH_PKGTOOLS in your src.conf(5).
792
79320130709:
794	Most of network statistics structures were changed to be able
795	keep 64-bits counters. Thus all tools, that work with networking
796	statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
797
79820130629:
799	Fix targets that run multiple make's to use && rather than ;
800	so that subsequent steps depend on success of previous.
801
802	NOTE: if building 'universe' with -j* on stable/8 or stable/9
803	it would be better to start the build using bmake, to avoid
804	overloading the machine.
805
80620130618:
807	Fix a bug that allowed a tracing process (e.g. gdb) to write
808	to a memory-mapped file in the traced process's address space
809	even if neither the traced process nor the tracing process had
810	write access to that file.
811
81220130615:
813	CVS has been removed from the base system.  An exact copy
814	of the code is available from the devel/cvs port.
815
81620130613:
817	Some people report the following error after the switch to bmake:
818
819		make: illegal option -- J
820		usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
821			...
822		*** [buildworld] Error code 2
823
824	this likely due to an old instance of make in
825	${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
826	which src/Makefile will use that blindly, if it exists, so if
827	you see the above error:
828
829		rm -rf `make -V MAKEPATH`
830
831	should resolve it.
832
83320130516:
834	Use bmake by default.
835	Whereas before one could choose to build with bmake via
836	-DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
837	make. The goal is to remove these knobs for 10-RELEASE.
838
839	It is worth noting that bmake (like gmake) treats the command
840	line as the unit of failure, rather than statements within the
841	command line.  Thus '(cd some/where && dosomething)' is safer
842	than 'cd some/where; dosomething'. The '()' allows consistent
843	behavior in parallel build.
844
84520130429:
846        Fix a bug that allows NFS clients to issue READDIR on files.
847
84820130426:
849	The WITHOUT_IDEA option has been removed because
850	the IDEA patent expired.
851
85220130426:
853	The sysctl which controls TRIM support under ZFS has been renamed
854	from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
855	enabled by default.
856
85720130425:
858	The mergemaster command now uses the default MAKEOBJDIRPREFIX
859	rather than creating it's own in the temporary directory in
860	order allow access to bootstrapped versions of tools such as
861	install and mtree.  When upgrading from version of FreeBSD where
862	the install command does not support -l, you will need to
863	install a new mergemaster command if mergemaster -p is required.
864	This can be accomplished with the command (cd src/usr.sbin/mergemaster
865	&& make install).
866
86720130404:
868	Legacy ATA stack, disabled and replaced by new CAM-based one since
869	FreeBSD 9.0, completely removed from the sources.  Kernel modules
870	atadisk and atapi*, user-level tools atacontrol and burncd are
871	removed.  Kernel option `options ATA_CAM` is now permanently enabled
872	and removed.
873
87420130319:
875	SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
876	and socketpair(2). Software, in particular Kerberos, may
877	automatically detect and use these during building. The resulting
878	binaries will not work on older kernels.
879
88020130308:
881	CTL_DISABLE has also been added to the sparc64 GENERIC (for further
882	information, see the respective 20130304 entry).
883
88420130304:
885	Recent commits to callout(9) changed the size of struct callout,
886	so the KBI is probably heavily disturbed. Also, some functions
887	in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
888	by macros. Every kernel module using it won't load, so rebuild
889	is requested.
890
891	The ctl device has been re-enabled in GENERIC for i386 and amd64,
892	but does not initialize by default (because of the new CTL_DISABLE
893	option) to save memory.  To re-enable it, remove the CTL_DISABLE
894	option from the kernel config file or set kern.cam.ctl.disable=0
895	in /boot/loader.conf.
896
89720130301:
898	The ctl device has been disabled in GENERIC for i386 and amd64.
899	This was done due to the extra memory being allocated at system
900	initialisation time by the ctl driver which was only used if
901	a CAM target device was created.  This makes a FreeBSD system
902	unusable on 128MB or less of RAM.
903
90420130208:
905	A new compression method (lz4) has been merged to -HEAD.  Please
906	refer to zpool-features(7) for more information.
907
908	Please refer to the "ZFS notes" section of this file for information
909	on upgrading boot ZFS pools.
910
91120130129:
912	A BSD-licensed patch(1) variant has been added and is installed
913	as bsdpatch, being the GNU version the default patch.
914	To inverse the logic and use the BSD-licensed one as default,
915	while having the GNU version installed as gnupatch, rebuild
916	and install world with the WITH_BSD_PATCH knob set.
917
91820130121:
919	Due to the use of the new -l option to install(1) during build
920	and install, you must take care not to directly set the INSTALL
921	make variable in your /etc/make.conf, /etc/src.conf, or on the
922	command line.  If you wish to use the -C flag for all installs
923	you may be able to add INSTALL+=-C to /etc/make.conf or
924	/etc/src.conf.
925
92620130118:
927	The install(1) option -M has changed meaning and now takes an
928	argument that is a file or path to append logs to.  In the
929	unlikely event that -M was the last option on the command line
930	and the command line contained at least two files and a target
931	directory the first file will have logs appended to it.  The -M
932	option served little practical purpose in the last decade so its
933	use is expected to be extremely rare.
934
93520121223:
936	After switching to Clang as the default compiler some users of ZFS
937	on i386 systems started to experience stack overflow kernel panics.
938	Please consider using 'options KSTACK_PAGES=4' in such configurations.
939
94020121222:
941	GEOM_LABEL now mangles label names read from file system metadata.
942	Mangling affect labels containing spaces, non-printable characters,
943	'%' or '"'. Device names in /etc/fstab and other places may need to
944	be updated.
945
94620121217:
947	By default, only the 10 most recent kernel dumps will be saved.  To
948	restore the previous behaviour (no limit on the number of kernel dumps
949	stored in the dump directory) add the following line to /etc/rc.conf:
950
951		savecore_flags=""
952
95320121201:
954	With the addition of auditdistd(8), a new auditdistd user is now
955	required during installworld.  "mergemaster -p" can be used to
956	add the user prior to installworld, as documented in the handbook.
957
95820121117:
959	The sin6_scope_id member variable in struct sockaddr_in6 is now
960	filled by the kernel before passing the structure to the userland via
961	sysctl or routing socket.  This means the KAME-specific embedded scope
962	id in sin6_addr.s6_addr[2] is always cleared in userland application.
963	This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
964	__FreeBSD_version is bumped to 1000025.
965
96620121105:
967	On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
968	This means that the world and kernel will be compiled with clang
969	and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
970	and /usr/bin/cpp.  To disable this behavior and revert to building
971	with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
972	of current may need to bootstrap WITHOUT_CLANG first if the clang
973	build fails (its compatibility window doesn't extend to the 9 stable
974	branch point).
975
97620121102:
977	The IPFIREWALL_FORWARD kernel option has been removed. Its
978	functionality now turned on by default.
979
98020121023:
981	The ZERO_COPY_SOCKET kernel option has been removed and
982	split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
983	NB: SOCKET_SEND_COW uses the VM page based copy-on-write
984	mechanism which is not safe and may result in kernel crashes.
985	NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
986	driver supports disposeable external page sized mbuf storage.
987	Proper replacements for both zero-copy mechanisms are under
988	consideration and will eventually lead to complete removal
989	of the two kernel options.
990
99120121023:
992	The IPv4 network stack has been converted to network byte
993	order. The following modules need to be recompiled together
994	with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
995	pf(4), ipfw(4), ng_ipfw(4), stf(4).
996
99720121022:
998	Support for non-MPSAFE filesystems was removed from VFS. The
999	VFS_VERSION was bumped, all filesystem modules shall be
1000	recompiled.
1001
100220121018:
1003	All the non-MPSAFE filesystems have been disconnected from
1004	the build. The full list includes: codafs, hpfs, ntfs, nwfs,
1005	portalfs, smbfs, xfs.
1006
100720121016:
1008	The interface cloning API and ABI has changed. The following
1009	modules need to be recompiled together with kernel:
1010	ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
1011	vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
1012	faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
1013
101420121015:
1015	The sdhci driver was split in two parts: sdhci (generic SD Host
1016	Controller logic) and sdhci_pci (actual hardware driver).
1017	No kernel config modifications are required, but if you
1018	load sdhc as a module you must switch to sdhci_pci instead.
1019
102020121014:
1021	Import the FUSE kernel and userland support into base system.
1022
102320121013:
1024	The GNU sort(1) program has been removed since the BSD-licensed
1025	sort(1) has been the default for quite some time and no serious
1026	problems have been reported.  The corresponding WITH_GNU_SORT
1027	knob has also gone.
1028
102920121006:
1030	The pfil(9) API/ABI for AF_INET family has been changed. Packet
1031	filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
1032	with new kernel.
1033
103420121001:
1035	The net80211(4) ABI has been changed to allow for improved driver
1036	PS-POLL and power-save support.  All wireless drivers need to be
1037	recompiled to work with the new kernel.
1038
103920120913:
1040	The random(4) support for the VIA hardware random number
1041	generator (`PADLOCK') is no longer enabled unconditionally.
1042	Add the padlock_rng device in the custom kernel config if
1043	needed.  The GENERIC kernels on i386 and amd64 do include the
1044	device, so the change only affects the custom kernel
1045	configurations.
1046
104720120908:
1048	The pf(4) packet filter ABI has been changed. pfctl(8) and
1049	snmp_pf module need to be recompiled to work with new kernel.
1050
105120120828:
1052	A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
1053	to -HEAD. Pools that have empty_bpobj in active state can not be
1054	imported read-write with ZFS implementations that do not support
1055	this feature. For more information read the zpool-features(5)
1056	manual page.
1057
105820120727:
1059	The sparc64 ZFS loader has been changed to no longer try to auto-
1060	detect ZFS providers based on diskN aliases but now requires these
1061	to be explicitly listed in the OFW boot-device environment variable.
1062
106320120712:
1064	The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
1065	libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
1066	configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
1067
106820120712:
1069	The following sysctls and tunables have been renamed for consistency
1070	with other variables:
1071	  kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
1072	  kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
1073
107420120628:
1075	The sort utility has been replaced with BSD sort.  For now, GNU sort
1076	is also available as "gnusort" or the default can be set back to
1077	GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
1078	installed as "bsdsort".
1079
108020120611:
1081	A new version of ZFS (pool version 5000) has been merged to -HEAD.
1082	Starting with this version the old system of ZFS pool versioning
1083	is superseded by "feature flags". This concept enables forward
1084	compatibility against certain future changes in functionality of ZFS
1085	pools. The first read-only compatible "feature flag" for ZFS pools
1086	is named "com.delphix:async_destroy". For more information
1087	read the new zpool-features(5) manual page.
1088	Please refer to the "ZFS notes" section of this file for information
1089	on upgrading boot ZFS pools.
1090
109120120417:
1092	The malloc(3) implementation embedded in libc now uses sources imported
1093	as contrib/jemalloc.  The most disruptive API change is to
1094	/etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
1095	delete it prior to installworld, and optionally re-create it using the
1096	new format after rebooting.  See malloc.conf(5) for details
1097	(specifically the TUNING section and the "opt.*" entries in the MALLCTL
1098	NAMESPACE section).
1099
110020120328:
1101	Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
1102	is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
1103	now spelled mips.  This is to aid compatibility with third-party
1104	software that expects this naming scheme in uname(3).  Little-endian
1105	settings are unchanged. If you are updating a big-endian mips64 machine
1106	from before this change, you may need to set MACHINE_ARCH=mips64 in
1107	your environment before the new build system will recognize your machine.
1108
110920120306:
1110	Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
1111	platforms.
1112
111320120229:
1114	Now unix domain sockets behave "as expected" on	nullfs(5). Previously
1115	nullfs(5) did not pass through all behaviours to the underlying layer,
1116	as a result if we bound to a socket on the lower layer we could connect
1117	only to the lower path; if we bound to the upper layer we could connect
1118	only to	the upper path. The new behavior is one can connect to both the
1119	lower and the upper paths regardless what layer path one binds to.
1120
112120120211:
1122	The getifaddrs upgrade path broken with 20111215 has been restored.
1123	If you have upgraded in between 20111215 and 20120209 you need to
1124	recompile libc again with your kernel.  You still need to recompile
1125	world to be able to configure CARP but this restriction already
1126	comes from 20111215.
1127
112820120114:
1129	The set_rcvar() function has been removed from /etc/rc.subr.  All
1130	base and ports rc.d scripts have been updated, so if you have a
1131	port installed with a script in /usr/local/etc/rc.d you can either
1132	hand-edit the rcvar= line, or reinstall the port.
1133
1134	An easy way to handle the mass-update of /etc/rc.d:
1135	rm /etc/rc.d/* && mergemaster -i
1136
113720120109:
1138	panic(9) now stops other CPUs in the SMP systems, disables interrupts
1139	on the current CPU and prevents other threads from running.
1140	This behavior can be reverted using the kern.stop_scheduler_on_panic
1141	tunable/sysctl.
1142	The new behavior can be incompatible with kern.sync_on_panic.
1143
114420111215:
1145	The carp(4) facility has been changed significantly. Configuration
1146	of the CARP protocol via ifconfig(8) has changed, as well as format
1147	of CARP events submitted to devd(8) has changed. See manual pages
1148	for more information. The arpbalance feature of carp(4) is currently
1149	not supported anymore.
1150
1151	Size of struct in_aliasreq, struct in6_aliasreq has changed. User
1152	utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
1153	need to be recompiled.
1154
115520111122:
1156	The acpi_wmi(4) status device /dev/wmistat has been renamed to
1157	/dev/wmistat0.
1158
115920111108:
1160	The option VFS_ALLOW_NONMPSAFE option has been added in order to
1161	explicitely support non-MPSAFE filesystems.
1162	It is on by default for all supported platform at this present
1163	time.
1164
116520111101:
1166	The broken amd(4) driver has been replaced with esp(4) in the amd64,
1167	i386 and pc98 GENERIC kernel configuration files.
1168
116920110930:
1170	sysinstall has been removed
1171
117220110923:
1173	The stable/9 branch created in subversion.  This corresponds to the
1174	RELENG_9 branch in CVS.
1175
1176COMMON ITEMS:
1177
1178	General Notes
1179	-------------
1180	Avoid using make -j when upgrading.  While generally safe, there are
1181	sometimes problems using -j to upgrade.  If your upgrade fails with
1182	-j, please try again without -j.  From time to time in the past there
1183	have been problems using -j with buildworld and/or installworld.  This
1184	is especially true when upgrading between "distant" versions (eg one
1185	that cross a major release boundary or several minor releases, or when
1186	several months have passed on the -current branch).
1187
1188	Sometimes, obscure build problems are the result of environment
1189	poisoning.  This can happen because the make utility reads its
1190	environment when searching for values for global variables.  To run
1191	your build attempts in an "environmental clean room", prefix all make
1192	commands with 'env -i '.  See the env(1) manual page for more details.
1193
1194	When upgrading from one major version to another it is generally best
1195	to upgrade to the latest code in the currently installed branch first,
1196	then do an upgrade to the new branch. This is the best-tested upgrade
1197	path, and has the highest probability of being successful.  Please try
1198	this approach before reporting problems with a major version upgrade.
1199
1200	When upgrading a live system, having a root shell around before
1201	installing anything can help undo problems. Not having a root shell
1202	around can lead to problems if pam has changed too much from your
1203	starting point to allow continued authentication after the upgrade.
1204
1205	This file should be read as a log of events. When a later event changes
1206	information of a prior event, the prior event should not be deleted.
1207	Instead, a pointer to the entry with the new information should be
1208	placed in the old entry. Readers of this file should also sanity check
1209	older entries before relying on them blindly. Authors of new entries
1210	should write them with this in mind.
1211
1212	ZFS notes
1213	---------
1214	When upgrading the boot ZFS pool to a new version, always follow
1215	these two steps:
1216
1217	1.) recompile and reinstall the ZFS boot loader and boot block
1218	(this is part of "make buildworld" and "make installworld")
1219
1220	2.) update the ZFS boot block on your boot drive
1221
1222	The following example updates the ZFS boot block on the first
1223	partition (freebsd-boot) of a GPT partitioned drive ada0:
1224	"gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
1225
1226	Non-boot pools do not need these updates.
1227
1228	To build a kernel
1229	-----------------
1230	If you are updating from a prior version of FreeBSD (even one just
1231	a few days old), you should follow this procedure.  It is the most
1232	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1233
1234	make kernel-toolchain
1235	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1236	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1237
1238	To test a kernel once
1239	---------------------
1240	If you just want to boot a kernel once (because you are not sure
1241	if it works, or if you want to boot a known bad kernel to provide
1242	debugging information) run
1243	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1244	nextboot -k testkernel
1245
1246	To just build a kernel when you know that it won't mess you up
1247	--------------------------------------------------------------
1248	This assumes you are already running a CURRENT system.  Replace
1249	${arch} with the architecture of your machine (e.g. "i386",
1250	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
1251
1252	cd src/sys/${arch}/conf
1253	config KERNEL_NAME_HERE
1254	cd ../compile/KERNEL_NAME_HERE
1255	make depend
1256	make
1257	make install
1258
1259	If this fails, go to the "To build a kernel" section.
1260
1261	To rebuild everything and install it on the current system.
1262	-----------------------------------------------------------
1263	# Note: sometimes if you are running current you gotta do more than
1264	# is listed here if you are upgrading from a really old current.
1265
1266	<make sure you have good level 0 dumps>
1267	make buildworld
1268	make kernel KERNCONF=YOUR_KERNEL_HERE
1269							[1]
1270	<reboot in single user>				[3]
1271	mergemaster -Fp					[5]
1272	make installworld
1273	mergemaster -Fi					[4]
1274	make delete-old					[6]
1275	<reboot>
1276
1277	To cross-install current onto a separate partition
1278	--------------------------------------------------
1279	# In this approach we use a separate partition to hold
1280	# current's root, 'usr', and 'var' directories.   A partition
1281	# holding "/", "/usr" and "/var" should be about 2GB in
1282	# size.
1283
1284	<make sure you have good level 0 dumps>
1285	<boot into -stable>
1286	make buildworld
1287	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1288	<maybe newfs current's root partition>
1289	<mount current's root partition on directory ${CURRENT_ROOT}>
1290	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
1291	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1292	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1293	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
1294	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1295	<reboot into current>
1296	<do a "native" rebuild/install as described in the previous section>
1297	<maybe install compatibility libraries from ports/misc/compat*>
1298	<reboot>
1299
1300
1301	To upgrade in-place from stable to current
1302	----------------------------------------------
1303	<make sure you have good level 0 dumps>
1304	make buildworld					[9]
1305	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
1306							[1]
1307	<reboot in single user>				[3]
1308	mergemaster -Fp					[5]
1309	make installworld
1310	mergemaster -Fi					[4]
1311	make delete-old					[6]
1312	<reboot>
1313
1314	Make sure that you've read the UPDATING file to understand the
1315	tweaks to various things you need.  At this point in the life
1316	cycle of current, things change often and you are on your own
1317	to cope.  The defaults can also change, so please read ALL of
1318	the UPDATING entries.
1319
1320	Also, if you are tracking -current, you must be subscribed to
1321	freebsd-current@freebsd.org.  Make sure that before you update
1322	your sources that you have read and understood all the recent
1323	messages there.  If in doubt, please track -stable which has
1324	much fewer pitfalls.
1325
1326	[1] If you have third party modules, such as vmware, you
1327	should disable them at this point so they don't crash your
1328	system on reboot.
1329
1330	[3] From the bootblocks, boot -s, and then do
1331		fsck -p
1332		mount -u /
1333		mount -a
1334		cd src
1335		adjkerntz -i		# if CMOS is wall time
1336	Also, when doing a major release upgrade, it is required that
1337	you boot into single user mode to do the installworld.
1338
1339	[4] Note: This step is non-optional.  Failure to do this step
1340	can result in a significant reduction in the functionality of the
1341	system.  Attempting to do it by hand is not recommended and those
1342	that pursue this avenue should read this file carefully, as well
1343	as the archives of freebsd-current and freebsd-hackers mailing lists
1344	for potential gotchas.  The -U option is also useful to consider.
1345	See mergemaster(8) for more information.
1346
1347	[5] Usually this step is a noop.  However, from time to time
1348	you may need to do this if you get unknown user in the following
1349	step.  It never hurts to do it all the time.  You may need to
1350	install a new mergemaster (cd src/usr.sbin/mergemaster && make
1351	install) after the buildworld before this step if you last updated
1352	from current before 20130425 or from -stable before 20130430.
1353
1354	[6] This only deletes old files and directories. Old libraries
1355	can be deleted by "make delete-old-libs", but you have to make
1356	sure that no program is using those libraries anymore.
1357
1358	[8] In order to have a kernel that can run the 4.x binaries needed to
1359	do an installworld, you must include the COMPAT_FREEBSD4 option in
1360	your kernel.  Failure to do so may leave you with a system that is
1361	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1362	required to run the 5.x binaries on more recent kernels.  And so on
1363	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1364
1365	Make sure that you merge any new devices from GENERIC since the
1366	last time you updated your kernel config file.
1367
1368	[9] When checking out sources, you must include the -P flag to have
1369	cvs prune empty directories.
1370
1371	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1372	"?=" instead of the "=" assignment operator, so that buildworld can
1373	override the CPUTYPE if it needs to.
1374
1375	MAKEOBJDIRPREFIX must be defined in an environment variable, and
1376	not on the command line, or in /etc/make.conf.  buildworld will
1377	warn if it is improperly defined.
1378FORMAT:
1379
1380This file contains a list, in reverse chronological order, of major
1381breakages in tracking -current.  It is not guaranteed to be a complete
1382list of such breakages, and only contains entries since September 23, 2011.
1383If you need to see UPDATING entries from before that date, you will need
1384to fetch an UPDATING file from an older FreeBSD release.
1385
1386Copyright information:
1387
1388Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1389
1390Redistribution, publication, translation and use, with or without
1391modification, in full or in part, in any form or format of this
1392document are permitted without further permission from the author.
1393
1394THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1395IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1396WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1397DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1398INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1399(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1400SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1401HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1402STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1403IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1404POSSIBILITY OF SUCH DAMAGE.
1405
1406Contact Warner Losh if you have any questions about your use of
1407this document.
1408
1409$FreeBSD$
1410