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