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