xref: /freebsd/UPDATING (revision 28f42739a547ffe0b5dfaaf9f49fb4c4813aa232)
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
3420150107:
35	ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
36	taken from the ELF Tool Chain project rather than GNU binutils. They
37	should be drop-in replacements, with the addition of arm64 support.
38	The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
39	binutils tools, if necessary.
40
4120150105:
42	The default Unbound configuration now enables remote control
43	using a local socket.  Users who have already enabled the
44	local_unbound service should regenerate their configuration
45	by running "service local_unbound setup" as root.
46
4720150102:
48	The GNU texinfo and GNU info pages have been removed.
49	To be able to view GNU info pages please install texinfo from ports.
50
5120141231:
52	Clang, llvm and lldb have been upgraded to 3.5.0 release.
53
54	As of this release, a prerequisite for building clang, llvm and lldb is
55	a C++11 capable compiler and C++11 standard library.  This means that to
56	be able to successfully build the cross-tools stage of buildworld, with
57	clang as the bootstrap compiler, your system compiler or cross compiler
58	should either be clang 3.3 or later, or gcc 4.8 or later, and your
59	system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
60	later.
61
62	On any standard FreeBSD 10.x or 11.x installation, where clang and
63	libc++ are on by default (that is, on x86 or arm), this should work out
64	of the box.
65
66	On 9.x installations where clang is enabled by default, e.g. on x86 and
67	powerpc, libc++ will not be enabled by default, so libc++ should be
68	built (with clang) and installed first.  If both clang and libc++ are
69	missing, build clang first, then use it to build libc++.
70
71	On 8.x and earlier installations, upgrade to 9.x first, and then follow
72	the instructions for 9.x above.
73
74	Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
75	default, and do not build clang.
76
77	Many embedded systems are resource constrained, and will not be able to
78	build clang in a reasonable time, or in some cases at all.  In those
79	cases, cross building bootable systems on amd64 is a workaround.
80
81	This new version of clang introduces a number of new warnings, of which
82	the following are most likely to appear:
83
84	-Wabsolute-value
85
86	This warns in two cases, for both C and C++:
87	* When the code is trying to take the absolute value of an unsigned
88	  quantity, which is effectively a no-op, and almost never what was
89	  intended.  The code should be fixed, if at all possible.  If you are
90	  sure that the unsigned quantity can be safely cast to signed, without
91	  loss of information or undefined behavior, you can add an explicit
92	  cast, or disable the warning.
93
94	* When the code is trying to take an absolute value, but the called
95	  abs() variant is for the wrong type, which can lead to truncation.
96	  If you want to disable the warning instead of fixing the code, please
97	  make sure that truncation will not occur, or it might lead to unwanted
98	  side-effects.
99
100	-Wtautological-undefined-compare and
101	-Wundefined-bool-conversion
102
103	These warn when C++ code is trying to compare 'this' against NULL, while
104	'this' should never be NULL in well-defined C++ code.  However, there is
105	some legacy (pre C++11) code out there, which actively abuses this
106	feature, which was less strictly defined in previous C++ versions.
107
108	Squid and openjdk do this, for example.  The warning can be turned off
109	for C++98 and earlier, but compiling the code in C++11 mode might result
110	in unexpected behavior; for example, the parts of the program that are
111	unreachable could be optimized away.
112
11320141222:
114	The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
115	kernel sources have been removed. The .h files remain, since some
116	utilities include them. This will need to be fixed later.
117	If "mount -t oldnfs ..." is attempted, it will fail.
118	If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
119	the utilities will report errors.
120
12120141121:
122	The handling of LOCAL_LIB_DIRS has been altered to skip addition of
123	directories to top level SUBDIR variable when their parent
124	directory is included in LOCAL_DIRS.  Users with build systems with
125	such hierarchies and without SUBDIR entries in the parent
126	directory Makefiles should add them or add the directories to
127	LOCAL_DIRS.
128
12920141109:
130	faith(4) and faithd(8) have been removed from the base system. Faith
131	has been obsolete for a very long time.
132
13320141104:
134	vt(4), the new console driver, is enabled by default. It brings
135	support for Unicode and double-width characters, as well as
136	support for UEFI and integration with the KMS kernel video
137	drivers.
138
139	You may need to update your console settings in /etc/rc.conf,
140	most probably the keymap. During boot, /etc/rc.d/syscons will
141	indicate what you need to do.
142
143	vt(4) still has issues and lacks some features compared to
144	syscons(4). See the wiki for up-to-date information:
145	  https://wiki.freebsd.org/Newcons
146
147	If you want to keep using syscons(4), you can do so by adding
148	the following line to /boot/loader.conf:
149	  kern.vty=sc
150
15120141102:
152	pjdfstest has been integrated into kyua as an opt-in test suite.
153	Please see share/doc/pjdfstest/README for more details on how to
154	execute it.
155
15620141009:
157	gperf has been removed from the base system for architectures
158	that use clang. Ports that require gperf will obtain it from the
159	devel/gperf port.
160
16120140923:
162	pjdfstest has been moved from tools/regression/pjdfstest to
163	contrib/pjdfstest .
164
16520140922:
166	At svn r271982, The default linux compat kernel ABI has been adjusted
167	to 2.6.18 in support of the linux-c6 compat ports infrastructure
168	update.  If you wish to continue using the linux-f10 compat ports,
169	add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
170	encouraged to update their linux-compat packages to linux-c6 during
171	their next update cycle.
172
17320140729:
174	The ofwfb driver, used to provide a graphics console on PowerPC when
175	using vt(4), no longer allows mmap() of all physical memory. This
176	will prevent Xorg on PowerPC with some ATI graphics cards from
177	initializing properly unless x11-servers/xorg-server is updated to
178	1.12.4_8 or newer.
179
18020140723:
181	The xdev targets have been converted to using TARGET and
182	TARGET_ARCH instead of XDEV and XDEV_ARCH.
183
18420140719:
185	The default unbound configuration has been modified to address
186	issues with reverse lookups on networks that use private
187	address ranges.  If you use the local_unbound service, run
188	"service local_unbound setup" as root to regenerate your
189	configuration, then "service local_unbound reload" to load the
190	new configuration.
191
19220140709:
193	The GNU texinfo and GNU info pages are not built and installed
194	anymore, WITH_INFO knob has been added to allow to built and install
195	them again.
196	UPDATE: see 20150102 entry on texinfo's removal
197
19820140708:
199	The GNU readline library is now an INTERNALLIB - that is, it is
200	statically linked into consumers (GDB and variants) in the base
201	system, and the shared library is no longer installed.  The
202	devel/readline port is available for third party software that
203	requires readline.
204
20520140702:
206	The Itanium architecture (ia64) has been removed from the list of
207	known architectures. This is the first step in the removal of the
208	architecture.
209
21020140701:
211	Commit r268115 has added NFSv4.1 server support, merged from
212	projects/nfsv4.1-server.  Since this includes changes to the
213	internal interfaces between the NFS related modules, a full
214	build of the kernel and modules will be necessary.
215	__FreeBSD_version has been bumped.
216
21720140629:
218	The WITHOUT_VT_SUPPORT kernel config knob has been renamed
219	WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
220	which differs from the behaviour controlled by this knob.)
221
22220140619:
223	Maximal length of the serial number in CTL was increased from 16 to
224	64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
225	and ctld, need to be rebuilt to work with a new kernel.
226
22720140606:
228	The libatf-c and libatf-c++ major versions were downgraded to 0 and
229	1 respectively to match the upstream numbers.  They were out of
230	sync because, when they were originally added to FreeBSD, the
231	upstream versions were not respected.  These libraries are private
232	and not yet built by default, so renumbering them should be a
233	non-issue.  However, unclean source trees will yield broken test
234	programs once the operator executes "make delete-old-libs" after a
235	"make installworld".
236
237	Additionally, the atf-sh binary was made private by moving it into
238	/usr/libexec/.  Already-built shell test programs will keep the
239	path to the old binary so they will break after "make delete-old"
240	is run.
241
242	If you are using WITH_TESTS=yes (not the default), wipe the object
243	tree and rebuild from scratch to prevent spurious test failures.
244	This is only needed once: the misnumbered libraries and misplaced
245	binaries have been added to OptionalObsoleteFiles.inc so they will
246	be removed during a clean upgrade.
247
24820140512:
249	Clang and llvm have been upgraded to 3.4.1 release.
250
25120140508:
252	We bogusly installed src.opts.mk in /usr/share/mk. This file should
253	be removed to avoid issues in the future (and has been added to
254	ObsoleteFiles.inc).
255
25620140505:
257	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
258	past, it affected all builds that used the bsd.*.mk files. The old
259	behavior was a bug, but people may have relied upon it. To get this
260	behavior back, you can .include /etc/src.conf from /etc/make.conf
261	(which is still global and isn't changed). This also changes the
262	behavior of incremental builds inside the tree of individual
263	directories. Set MAKESYSPATH to ".../share/mk" to do that.
264	Although this has survived make universe and some upgrade scenarios,
265	other upgrade scenarios may have broken. At least one form of
266	temporary breakage was fixed with MAKESYSPATH settings for buildworld
267	as well... In cases where MAKESYSPATH isn't working with this
268	setting, you'll need to set it to the full path to your tree.
269
270	One side effect of all this cleaning up is that bsd.compiler.mk
271	is no longer implicitly included by bsd.own.mk. If you wish to
272	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
273	as well.
274
27520140430:
276	The lindev device has been removed since /dev/full has been made a
277	standard device.  __FreeBSD_version has been bumped.
278
27920140418:
280	The YES_HESIOD knob has been removed. It has been obsolete for
281	a decade. Please move to using WITH_HESIOD instead or your builds
282	will silently lack HESIOD.
283
28420140405:
285	The uart(4) driver has been changed with respect to its handling
286	of the low-level console. Previously the uart(4) driver prevented
287	any process from changing the baudrate or the CLOCAL and HUPCL
288	control flags. By removing the restrictions, operators can make
289	changes to the serial console port without having to reboot.
290	However, when getty(8) is started on the serial device that is
291	associated with the low-level console, a misconfigured terminal
292	line in /etc/ttys will now have a real impact.
293	Before upgrading the kernel, make sure that /etc/ttys has the
294	serial console device configured as 3wire without baudrate to
295	preserve the previous behaviour. E.g:
296	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
297
29820140306:
299	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
300	to improve performance.  To re-enable it, if needed, run rpcbind
301	with command line option -W.
302
30320140226:
304	Switched back to the GPL dtc compiler due to updates in the upstream
305	dts files not being supported by the BSDL dtc compiler. You will need
306	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
307	may result while building dtb files during a kernel build if you fail
308	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
309
31020140216:
311	Clang and llvm have been upgraded to 3.4 release.
312
31320140216:
314	The nve(4) driver has been removed.  Please use the nfe(4) driver
315	for NVIDIA nForce MCP Ethernet adapters instead.
316
31720140212:
318	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
319	This could cause certain C++ applications using shared libraries built
320	against the previous version of libc++ to crash.  The incompatibility
321	has now been fixed, but any C++ applications or shared libraries built
322	between r261283 and r261801 should be recompiled.
323
32420140204:
325	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
326	capability mode support.  Please note that enabling the feature in
327	kernel is still highly recommended.
328
32920140131:
330	OpenSSH is now built with sandbox support, and will use sandbox as
331	the default privilege separation method.  This requires Capsicum
332	capability mode support in kernel.
333
33420140128:
335	The libelf and libdwarf libraries have been updated to newer
336	versions from upstream. Shared library version numbers for
337	these two libraries were bumped. Any ports or binaries
338	requiring these two libraries should be recompiled.
339	__FreeBSD_version is bumped to 1100006.
340
34120140110:
342	If a Makefile in a tests/ directory was auto-generating a Kyuafile
343	instead of providing an explicit one, this would prevent such
344	Makefile from providing its own Kyuafile in the future during
345	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
346	intervention is needed to clean an objdir if you use NO_CLEAN:
347	  # find /usr/obj -name Kyuafile | xargs rm -f
348
34920131213:
350	The behavior of gss_pseudo_random() for the krb5 mechanism
351	has changed, for applications requesting a longer random string
352	than produced by the underlying enctype's pseudo-random() function.
353	In particular, the random string produced from a session key of
354	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
355	be different at the 17th octet and later, after this change.
356	The counter used in the PRF+ construction is now encoded as a
357	big-endian integer in accordance with RFC 4402.
358	__FreeBSD_version is bumped to 1100004.
359
36020131108:
361	The WITHOUT_ATF build knob has been removed and its functionality
362	has been subsumed into the more generic WITHOUT_TESTS.  If you were
363	using the former to disable the build of the ATF libraries, you
364	should change your settings to use the latter.
365
36620131025:
367	The default version of mtree is nmtree which is obtained from
368	NetBSD.  The output is generally the same, but may vary
369	slightly.  If you found you need identical output adding
370	"-F freebsd9" to the command line should do the trick.  For the
371	time being, the old mtree is available as fmtree.
372
37320131014:
374	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
375	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
376	1.1.4_8 and verify bsdyml not linked in, before running "make
377	delete-old-libs":
378	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
379	  or
380	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
381
38220131010:
383	The rc.d/jail script has been updated to support jail(8)
384	configuration file.  The "jail_<jname>_*" rc.conf(5) variables
385	for per-jail configuration are automatically converted to
386	/var/run/jail.<jname>.conf before the jail(8) utility is invoked.
387	This is transparently backward compatible.  See below about some
388	incompatibilities and rc.conf(5) manual page for more details.
389
390	These variables are now deprecated in favor of jail(8) configuration
391	file.  One can use "rc.d/jail config <jname>" command to generate
392	a jail(8) configuration file in /var/run/jail.<jname>.conf without
393	running the jail(8) utility.   The default pathname of the
394	configuration file is /etc/jail.conf and can be specified by
395	using $jail_conf or $jail_<jname>_conf variables.
396
397	Please note that jail_devfs_ruleset accepts an integer at
398	this moment.  Please consider to rewrite the ruleset name
399	with an integer.
400
40120130930:
402	BIND has been removed from the base system.  If all you need
403	is a local resolver, simply enable and start the local_unbound
404	service instead.  Otherwise, several versions of BIND are
405	available in the ports tree.   The dns/bind99 port is one example.
406
407	With this change, nslookup(1) and dig(1) are no longer in the base
408	system.  Users should instead use host(1) and drill(1) which are
409	in the base system.  Alternatively, nslookup and dig can
410	be obtained by installing the dns/bind-tools port.
411
41220130916:
413	With the addition of unbound(8), a new unbound user is now
414	required during installworld.  "mergemaster -p" can be used to
415	add the user prior to installworld, as documented in the handbook.
416
41720130911:
418	OpenSSH is now built with DNSSEC support, and will by default
419	silently trust signed SSHFP records.  This can be controlled with
420	the VerifyHostKeyDNS client configuration setting.  DNSSEC support
421	can be disabled entirely with the WITHOUT_LDNS option in src.conf.
422
42320130906:
424	The GNU Compiler Collection and C++ standard library (libstdc++)
425	are no longer built by default on platforms where clang is the system
426	compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
427	options in src.conf.
428
42920130905:
430	The PROCDESC kernel option is now part of the GENERIC kernel
431	configuration and is required for the rwhod(8) to work.
432	If you are using custom kernel configuration, you should include
433	'options PROCDESC'.
434
43520130905:
436	The API and ABI related to the Capsicum framework was modified
437	in backward incompatible way. The userland libraries and programs
438	have to be recompiled to work with the new kernel. This includes the
439	following libraries and programs, but the whole buildworld is
440	advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
441	kdump, procstat, rwho, rwhod, uniq.
442
44320130903:
444	AES-NI intrinsic support has been added to gcc.  The AES-NI module
445	has been updated to use this support.  A new gcc is required to build
446	the aesni module on both i386 and amd64.
447
44820130821:
449	The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
450	Thus "device padlock_rng" and "device rdrand_rng" should be
451	used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
452
45320130813:
454	WITH_ICONV has been split into two feature sets.  WITH_ICONV now
455	enables just the iconv* functionality and is now on by default.
456	WITH_LIBICONV_COMPAT enables the libiconv api and link time
457	compatability.  Set WITHOUT_ICONV to build the old way.
458	If you have been using WITH_ICONV before, you will very likely
459	need to turn on WITH_LIBICONV_COMPAT.
460
46120130806:
462	INVARIANTS option now enables DEBUG for code with OpenSolaris and
463	Illumos origin, including ZFS.  If you have INVARIANTS in your
464	kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
465	explicitly.
466	DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
467	locks if WITNESS option was set.  Because that generated a lot of
468	witness(9) reports and all of them were believed to be false
469	positives, this is no longer done.  New option OPENSOLARIS_WITNESS
470	can be used to achieve the previous behavior.
471
47220130806:
473	Timer values in IPv6 data structures now use time_uptime instead
474	of time_second.  Although this is not a user-visible functional
475	change, userland utilities which directly use them---ndp(8),
476	rtadvd(8), and rtsold(8) in the base system---need to be updated
477	to r253970 or later.
478
47920130802:
480	find -delete can now delete the pathnames given as arguments,
481	instead of only files found below them or if the pathname did
482	not contain any slashes. Formerly, the following error message
483	would result:
484
485	find: -delete: <path>: relative path potentially not safe
486
487	Deleting the pathnames given as arguments can be prevented
488	without error messages using -mindepth 1 or by changing
489	directory and passing "." as argument to find. This works in the
490	old as well as the new version of find.
491
49220130726:
493	Behavior of devfs rules path matching has been changed.
494	Pattern is now always matched against fully qualified devfs
495	path and slash characters must be explicitly matched by
496	slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
497	subdirectories must be reviewed.
498
49920130716:
500	The default ARM ABI has changed to the ARM EABI. The old ABI is
501	incompatible with the ARM EABI and all programs and modules will
502	need to be rebuilt to work with a new kernel.
503
504	To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
505
506	NOTE: Support for the old ABI will be removed in the future and
507	users are advised to upgrade.
508
50920130709:
510	pkg_install has been disconnected from the build if you really need it
511	you should add WITH_PKGTOOLS in your src.conf(5).
512
51320130709:
514	Most of network statistics structures were changed to be able
515	keep 64-bits counters. Thus all tools, that work with networking
516	statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
517
51820130629:
519	Fix targets that run multiple make's to use && rather than ;
520	so that subsequent steps depend on success of previous.
521
522	NOTE: if building 'universe' with -j* on stable/8 or stable/9
523	it would be better to start the build using bmake, to avoid
524	overloading the machine.
525
52620130618:
527	Fix a bug that allowed a tracing process (e.g. gdb) to write
528	to a memory-mapped file in the traced process's address space
529	even if neither the traced process nor the tracing process had
530	write access to that file.
531
53220130615:
533	CVS has been removed from the base system.  An exact copy
534	of the code is available from the devel/cvs port.
535
53620130613:
537	Some people report the following error after the switch to bmake:
538
539		make: illegal option -- J
540		usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
541			...
542		*** [buildworld] Error code 2
543
544	this likely due to an old instance of make in
545	${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
546	which src/Makefile will use that blindly, if it exists, so if
547	you see the above error:
548
549		rm -rf `make -V MAKEPATH`
550
551	should resolve it.
552
55320130516:
554	Use bmake by default.
555	Whereas before one could choose to build with bmake via
556	-DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
557	make. The goal is to remove these knobs for 10-RELEASE.
558
559	It is worth noting that bmake (like gmake) treats the command
560	line as the unit of failure, rather than statements within the
561	command line.  Thus '(cd some/where && dosomething)' is safer
562	than 'cd some/where; dosomething'. The '()' allows consistent
563	behavior in parallel build.
564
56520130429:
566        Fix a bug that allows NFS clients to issue READDIR on files.
567
56820130426:
569	The WITHOUT_IDEA option has been removed because
570	the IDEA patent expired.
571
57220130426:
573	The sysctl which controls TRIM support under ZFS has been renamed
574	from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
575	enabled by default.
576
57720130425:
578	The mergemaster command now uses the default MAKEOBJDIRPREFIX
579	rather than creating it's own in the temporary directory in
580	order allow access to bootstrapped versions of tools such as
581	install and mtree.  When upgrading from version of FreeBSD where
582	the install command does not support -l, you will need to
583	install a new mergemaster command if mergemaster -p is required.
584	This can be accomplished with the command (cd src/usr.sbin/mergemaster
585	&& make install).
586
58720130404:
588	Legacy ATA stack, disabled and replaced by new CAM-based one since
589	FreeBSD 9.0, completely removed from the sources.  Kernel modules
590	atadisk and atapi*, user-level tools atacontrol and burncd are
591	removed.  Kernel option `options ATA_CAM` is now permanently enabled
592	and removed.
593
59420130319:
595	SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
596	and socketpair(2). Software, in particular Kerberos, may
597	automatically detect and use these during building. The resulting
598	binaries will not work on older kernels.
599
60020130308:
601	CTL_DISABLE has also been added to the sparc64 GENERIC (for further
602	information, see the respective 20130304 entry).
603
60420130304:
605	Recent commits to callout(9) changed the size of struct callout,
606	so the KBI is probably heavily disturbed. Also, some functions
607	in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
608	by macros. Every kernel module using it won't load, so rebuild
609	is requested.
610
611	The ctl device has been re-enabled in GENERIC for i386 and amd64,
612	but does not initialize by default (because of the new CTL_DISABLE
613	option) to save memory.  To re-enable it, remove the CTL_DISABLE
614	option from the kernel config file or set kern.cam.ctl.disable=0
615	in /boot/loader.conf.
616
61720130301:
618	The ctl device has been disabled in GENERIC for i386 and amd64.
619	This was done due to the extra memory being allocated at system
620	initialisation time by the ctl driver which was only used if
621	a CAM target device was created.  This makes a FreeBSD system
622	unusable on 128MB or less of RAM.
623
62420130208:
625	A new compression method (lz4) has been merged to -HEAD.  Please
626	refer to zpool-features(7) for more information.
627
628	Please refer to the "ZFS notes" section of this file for information
629	on upgrading boot ZFS pools.
630
63120130129:
632	A BSD-licensed patch(1) variant has been added and is installed
633	as bsdpatch, being the GNU version the default patch.
634	To inverse the logic and use the BSD-licensed one as default,
635	while having the GNU version installed as gnupatch, rebuild
636	and install world with the WITH_BSD_PATCH knob set.
637
63820130121:
639	Due to the use of the new -l option to install(1) during build
640	and install, you must take care not to directly set the INSTALL
641	make variable in your /etc/make.conf, /etc/src.conf, or on the
642	command line.  If you wish to use the -C flag for all installs
643	you may be able to add INSTALL+=-C to /etc/make.conf or
644	/etc/src.conf.
645
64620130118:
647	The install(1) option -M has changed meaning and now takes an
648	argument that is a file or path to append logs to.  In the
649	unlikely event that -M was the last option on the command line
650	and the command line contained at least two files and a target
651	directory the first file will have logs appended to it.  The -M
652	option served little practical purpose in the last decade so its
653	use is expected to be extremely rare.
654
65520121223:
656	After switching to Clang as the default compiler some users of ZFS
657	on i386 systems started to experience stack overflow kernel panics.
658	Please consider using 'options KSTACK_PAGES=4' in such configurations.
659
66020121222:
661	GEOM_LABEL now mangles label names read from file system metadata.
662	Mangling affect labels containing spaces, non-printable characters,
663	'%' or '"'. Device names in /etc/fstab and other places may need to
664	be updated.
665
66620121217:
667	By default, only the 10 most recent kernel dumps will be saved.  To
668	restore the previous behaviour (no limit on the number of kernel dumps
669	stored in the dump directory) add the following line to /etc/rc.conf:
670
671		savecore_flags=""
672
67320121201:
674	With the addition of auditdistd(8), a new auditdistd user is now
675	required during installworld.  "mergemaster -p" can be used to
676	add the user prior to installworld, as documented in the handbook.
677
67820121117:
679	The sin6_scope_id member variable in struct sockaddr_in6 is now
680	filled by the kernel before passing the structure to the userland via
681	sysctl or routing socket.  This means the KAME-specific embedded scope
682	id in sin6_addr.s6_addr[2] is always cleared in userland application.
683	This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
684	__FreeBSD_version is bumped to 1000025.
685
68620121105:
687	On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
688	This means that the world and kernel will be compiled with clang
689	and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
690	and /usr/bin/cpp.  To disable this behavior and revert to building
691	with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
692	of current may need to bootstrap WITHOUT_CLANG first if the clang
693	build fails (its compatibility window doesn't extend to the 9 stable
694	branch point).
695
69620121102:
697	The IPFIREWALL_FORWARD kernel option has been removed. Its
698	functionality now turned on by default.
699
70020121023:
701	The ZERO_COPY_SOCKET kernel option has been removed and
702	split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
703	NB: SOCKET_SEND_COW uses the VM page based copy-on-write
704	mechanism which is not safe and may result in kernel crashes.
705	NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
706	driver supports disposeable external page sized mbuf storage.
707	Proper replacements for both zero-copy mechanisms are under
708	consideration and will eventually lead to complete removal
709	of the two kernel options.
710
71120121023:
712	The IPv4 network stack has been converted to network byte
713	order. The following modules need to be recompiled together
714	with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
715	pf(4), ipfw(4), ng_ipfw(4), stf(4).
716
71720121022:
718	Support for non-MPSAFE filesystems was removed from VFS. The
719	VFS_VERSION was bumped, all filesystem modules shall be
720	recompiled.
721
72220121018:
723	All the non-MPSAFE filesystems have been disconnected from
724	the build. The full list includes: codafs, hpfs, ntfs, nwfs,
725	portalfs, smbfs, xfs.
726
72720121016:
728	The interface cloning API and ABI has changed. The following
729	modules need to be recompiled together with kernel:
730	ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
731	vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
732	faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
733
73420121015:
735	The sdhci driver was split in two parts: sdhci (generic SD Host
736	Controller logic) and sdhci_pci (actual hardware driver).
737	No kernel config modifications are required, but if you
738	load sdhc as a module you must switch to sdhci_pci instead.
739
74020121014:
741	Import the FUSE kernel and userland support into base system.
742
74320121013:
744	The GNU sort(1) program has been removed since the BSD-licensed
745	sort(1) has been the default for quite some time and no serious
746	problems have been reported.  The corresponding WITH_GNU_SORT
747	knob has also gone.
748
74920121006:
750	The pfil(9) API/ABI for AF_INET family has been changed. Packet
751	filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
752	with new kernel.
753
75420121001:
755	The net80211(4) ABI has been changed to allow for improved driver
756	PS-POLL and power-save support.  All wireless drivers need to be
757	recompiled to work with the new kernel.
758
75920120913:
760	The random(4) support for the VIA hardware random number
761	generator (`PADLOCK') is no longer enabled unconditionally.
762	Add the padlock_rng device in the custom kernel config if
763	needed.  The GENERIC kernels on i386 and amd64 do include the
764	device, so the change only affects the custom kernel
765	configurations.
766
76720120908:
768	The pf(4) packet filter ABI has been changed. pfctl(8) and
769	snmp_pf module need to be recompiled to work with new kernel.
770
77120120828:
772	A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
773	to -HEAD. Pools that have empty_bpobj in active state can not be
774	imported read-write with ZFS implementations that do not support
775	this feature. For more information read the zpool-features(5)
776	manual page.
777
77820120727:
779	The sparc64 ZFS loader has been changed to no longer try to auto-
780	detect ZFS providers based on diskN aliases but now requires these
781	to be explicitly listed in the OFW boot-device environment variable.
782
78320120712:
784	The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
785	libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
786	configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
787
78820120712:
789	The following sysctls and tunables have been renamed for consistency
790	with other variables:
791	  kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
792	  kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
793
79420120628:
795	The sort utility has been replaced with BSD sort.  For now, GNU sort
796	is also available as "gnusort" or the default can be set back to
797	GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
798	installed as "bsdsort".
799
80020120611:
801	A new version of ZFS (pool version 5000) has been merged to -HEAD.
802	Starting with this version the old system of ZFS pool versioning
803	is superseded by "feature flags". This concept enables forward
804	compatibility against certain future changes in functionality of ZFS
805	pools. The first read-only compatible "feature flag" for ZFS pools
806	is named "com.delphix:async_destroy". For more information
807	read the new zpool-features(5) manual page.
808	Please refer to the "ZFS notes" section of this file for information
809	on upgrading boot ZFS pools.
810
81120120417:
812	The malloc(3) implementation embedded in libc now uses sources imported
813	as contrib/jemalloc.  The most disruptive API change is to
814	/etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
815	delete it prior to installworld, and optionally re-create it using the
816	new format after rebooting.  See malloc.conf(5) for details
817	(specifically the TUNING section and the "opt.*" entries in the MALLCTL
818	NAMESPACE section).
819
82020120328:
821	Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
822	is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
823	now spelled mips.  This is to aid compatibility with third-party
824	software that expects this naming scheme in uname(3).  Little-endian
825	settings are unchanged. If you are updating a big-endian mips64 machine
826	from before this change, you may need to set MACHINE_ARCH=mips64 in
827	your environment before the new build system will recognize your machine.
828
82920120306:
830	Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
831	platforms.
832
83320120229:
834	Now unix domain sockets behave "as expected" on	nullfs(5). Previously
835	nullfs(5) did not pass through all behaviours to the underlying layer,
836	as a result if we bound to a socket on the lower layer we could connect
837	only to the lower path; if we bound to the upper layer we could connect
838	only to	the upper path. The new behavior is one can connect to both the
839	lower and the upper paths regardless what layer path one binds to.
840
84120120211:
842	The getifaddrs upgrade path broken with 20111215 has been restored.
843	If you have upgraded in between 20111215 and 20120209 you need to
844	recompile libc again with your kernel.  You still need to recompile
845	world to be able to configure CARP but this restriction already
846	comes from 20111215.
847
84820120114:
849	The set_rcvar() function has been removed from /etc/rc.subr.  All
850	base and ports rc.d scripts have been updated, so if you have a
851	port installed with a script in /usr/local/etc/rc.d you can either
852	hand-edit the rcvar= line, or reinstall the port.
853
854	An easy way to handle the mass-update of /etc/rc.d:
855	rm /etc/rc.d/* && mergemaster -i
856
85720120109:
858	panic(9) now stops other CPUs in the SMP systems, disables interrupts
859	on the current CPU and prevents other threads from running.
860	This behavior can be reverted using the kern.stop_scheduler_on_panic
861	tunable/sysctl.
862	The new behavior can be incompatible with kern.sync_on_panic.
863
86420111215:
865	The carp(4) facility has been changed significantly. Configuration
866	of the CARP protocol via ifconfig(8) has changed, as well as format
867	of CARP events submitted to devd(8) has changed. See manual pages
868	for more information. The arpbalance feature of carp(4) is currently
869	not supported anymore.
870
871	Size of struct in_aliasreq, struct in6_aliasreq has changed. User
872	utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
873	need to be recompiled.
874
87520111122:
876	The acpi_wmi(4) status device /dev/wmistat has been renamed to
877	/dev/wmistat0.
878
87920111108:
880	The option VFS_ALLOW_NONMPSAFE option has been added in order to
881	explicitely support non-MPSAFE filesystems.
882	It is on by default for all supported platform at this present
883	time.
884
88520111101:
886	The broken amd(4) driver has been replaced with esp(4) in the amd64,
887	i386 and pc98 GENERIC kernel configuration files.
888
88920110930:
890	sysinstall has been removed
891
89220110923:
893	The stable/9 branch created in subversion.  This corresponds to the
894	RELENG_9 branch in CVS.
895
896COMMON ITEMS:
897
898	General Notes
899	-------------
900	Avoid using make -j when upgrading.  While generally safe, there are
901	sometimes problems using -j to upgrade.  If your upgrade fails with
902	-j, please try again without -j.  From time to time in the past there
903	have been problems using -j with buildworld and/or installworld.  This
904	is especially true when upgrading between "distant" versions (eg one
905	that cross a major release boundary or several minor releases, or when
906	several months have passed on the -current branch).
907
908	Sometimes, obscure build problems are the result of environment
909	poisoning.  This can happen because the make utility reads its
910	environment when searching for values for global variables.  To run
911	your build attempts in an "environmental clean room", prefix all make
912	commands with 'env -i '.  See the env(1) manual page for more details.
913
914	When upgrading from one major version to another it is generally best
915	to upgrade to the latest code in the currently installed branch first,
916	then do an upgrade to the new branch. This is the best-tested upgrade
917	path, and has the highest probability of being successful.  Please try
918	this approach before reporting problems with a major version upgrade.
919
920	When upgrading a live system, having a root shell around before
921	installing anything can help undo problems. Not having a root shell
922	around can lead to problems if pam has changed too much from your
923	starting point to allow continued authentication after the upgrade.
924
925	ZFS notes
926	---------
927	When upgrading the boot ZFS pool to a new version, always follow
928	these two steps:
929
930	1.) recompile and reinstall the ZFS boot loader and boot block
931	(this is part of "make buildworld" and "make installworld")
932
933	2.) update the ZFS boot block on your boot drive
934
935	The following example updates the ZFS boot block on the first
936	partition (freebsd-boot) of a GPT partitioned drive ada0:
937	"gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
938
939	Non-boot pools do not need these updates.
940
941	To build a kernel
942	-----------------
943	If you are updating from a prior version of FreeBSD (even one just
944	a few days old), you should follow this procedure.  It is the most
945	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
946
947	make kernel-toolchain
948	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
949	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
950
951	To test a kernel once
952	---------------------
953	If you just want to boot a kernel once (because you are not sure
954	if it works, or if you want to boot a known bad kernel to provide
955	debugging information) run
956	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
957	nextboot -k testkernel
958
959	To just build a kernel when you know that it won't mess you up
960	--------------------------------------------------------------
961	This assumes you are already running a CURRENT system.  Replace
962	${arch} with the architecture of your machine (e.g. "i386",
963	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
964
965	cd src/sys/${arch}/conf
966	config KERNEL_NAME_HERE
967	cd ../compile/KERNEL_NAME_HERE
968	make depend
969	make
970	make install
971
972	If this fails, go to the "To build a kernel" section.
973
974	To rebuild everything and install it on the current system.
975	-----------------------------------------------------------
976	# Note: sometimes if you are running current you gotta do more than
977	# is listed here if you are upgrading from a really old current.
978
979	<make sure you have good level 0 dumps>
980	make buildworld
981	make kernel KERNCONF=YOUR_KERNEL_HERE
982							[1]
983	<reboot in single user>				[3]
984	mergemaster -Fp					[5]
985	make installworld
986	mergemaster -Fi					[4]
987	make delete-old					[6]
988	<reboot>
989
990	To cross-install current onto a separate partition
991	--------------------------------------------------
992	# In this approach we use a separate partition to hold
993	# current's root, 'usr', and 'var' directories.   A partition
994	# holding "/", "/usr" and "/var" should be about 2GB in
995	# size.
996
997	<make sure you have good level 0 dumps>
998	<boot into -stable>
999	make buildworld
1000	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1001	<maybe newfs current's root partition>
1002	<mount current's root partition on directory ${CURRENT_ROOT}>
1003	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
1004	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1005	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1006	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
1007	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1008	<reboot into current>
1009	<do a "native" rebuild/install as described in the previous section>
1010	<maybe install compatibility libraries from ports/misc/compat*>
1011	<reboot>
1012
1013
1014	To upgrade in-place from stable to current
1015	----------------------------------------------
1016	<make sure you have good level 0 dumps>
1017	make buildworld					[9]
1018	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
1019							[1]
1020	<reboot in single user>				[3]
1021	mergemaster -Fp					[5]
1022	make installworld
1023	mergemaster -Fi					[4]
1024	make delete-old					[6]
1025	<reboot>
1026
1027	Make sure that you've read the UPDATING file to understand the
1028	tweaks to various things you need.  At this point in the life
1029	cycle of current, things change often and you are on your own
1030	to cope.  The defaults can also change, so please read ALL of
1031	the UPDATING entries.
1032
1033	Also, if you are tracking -current, you must be subscribed to
1034	freebsd-current@freebsd.org.  Make sure that before you update
1035	your sources that you have read and understood all the recent
1036	messages there.  If in doubt, please track -stable which has
1037	much fewer pitfalls.
1038
1039	[1] If you have third party modules, such as vmware, you
1040	should disable them at this point so they don't crash your
1041	system on reboot.
1042
1043	[3] From the bootblocks, boot -s, and then do
1044		fsck -p
1045		mount -u /
1046		mount -a
1047		cd src
1048		adjkerntz -i		# if CMOS is wall time
1049	Also, when doing a major release upgrade, it is required that
1050	you boot into single user mode to do the installworld.
1051
1052	[4] Note: This step is non-optional.  Failure to do this step
1053	can result in a significant reduction in the functionality of the
1054	system.  Attempting to do it by hand is not recommended and those
1055	that pursue this avenue should read this file carefully, as well
1056	as the archives of freebsd-current and freebsd-hackers mailing lists
1057	for potential gotchas.  The -U option is also useful to consider.
1058	See mergemaster(8) for more information.
1059
1060	[5] Usually this step is a noop.  However, from time to time
1061	you may need to do this if you get unknown user in the following
1062	step.  It never hurts to do it all the time.  You may need to
1063	install a new mergemaster (cd src/usr.sbin/mergemaster && make
1064	install) after the buildworld before this step if you last updated
1065	from current before 20130425 or from -stable before 20130430.
1066
1067	[6] This only deletes old files and directories. Old libraries
1068	can be deleted by "make delete-old-libs", but you have to make
1069	sure that no program is using those libraries anymore.
1070
1071	[8] In order to have a kernel that can run the 4.x binaries needed to
1072	do an installworld, you must include the COMPAT_FREEBSD4 option in
1073	your kernel.  Failure to do so may leave you with a system that is
1074	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1075	required to run the 5.x binaries on more recent kernels.  And so on
1076	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1077
1078	Make sure that you merge any new devices from GENERIC since the
1079	last time you updated your kernel config file.
1080
1081	[9] When checking out sources, you must include the -P flag to have
1082	cvs prune empty directories.
1083
1084	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1085	"?=" instead of the "=" assignment operator, so that buildworld can
1086	override the CPUTYPE if it needs to.
1087
1088	MAKEOBJDIRPREFIX must be defined in an environment variable, and
1089	not on the command line, or in /etc/make.conf.  buildworld will
1090	warn if it is improperly defined.
1091FORMAT:
1092
1093This file contains a list, in reverse chronological order, of major
1094breakages in tracking -current.  It is not guaranteed to be a complete
1095list of such breakages, and only contains entries since October 10, 2007.
1096If you need to see UPDATING entries from before that date, you will need
1097to fetch an UPDATING file from an older FreeBSD release.
1098
1099Copyright information:
1100
1101Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1102
1103Redistribution, publication, translation and use, with or without
1104modification, in full or in part, in any form or format of this
1105document are permitted without further permission from the author.
1106
1107THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1108IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1109WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1110DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1111INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1112(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1113SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1114HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1115STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1116IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1117POSSIBILITY OF SUCH DAMAGE.
1118
1119Contact Warner Losh if you have any questions about your use of
1120this document.
1121
1122$FreeBSD$
1123