xref: /freebsd/UPDATING (revision 3fe8969a749c0e4a62ffdbf4f6883898027a9e19)
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
3420141102:
35	pjdfstest has been integrated into kyua as an opt-in test suite.
36	Please see share/doc/pjdfstest/README for a more details on how to
37	execute it.
38
3920141009:
40	gperf has been removed from the base system for architectures
41	that use clang. Ports that require gperf will obtain it from the
42	devel/gperf port.
43
4420140923:
45	pjdfstest has been moved from tools/regression/pjdfstest to
46	contrib/pjdfstest .
47
4820140922:
49	At svn r271982, The default linux compat kernel ABI has been adjusted
50	to 2.6.18 in support of the linux-c6 compat ports infrastructure
51	update.  If you wish to continue using the linux-f10 compat ports,
52	add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
53	encouraged to update their linux-compat packages to linux-c6 during
54	their next update cycle.
55
5620140729:
57	The ofwfb driver, used to provide a graphics console on PowerPC when
58	using vt(4), no longer allows mmap() of all of physical memory. This
59	will prevent Xorg on PowerPC with some ATI graphics cards from
60	initializing properly unless x11-servers/xorg-server is updated to
61	1.12.4_8 or newer.
62
6320140723:
64	The xdev targets have been converted to using TARGET and
65	TARGET_ARCH instead of XDEV and XDEV_ARCH.
66
6720140719:
68	The default unbound configuration has been modified to address
69	issues with reverse lookups on networks that use private
70	address ranges.  If you use the local_unbound service, run
71	"service local_unbound setup" as root to regenerate your
72	configuration, then "service local_unbound reload" to load the
73	new configuration.
74
7520140709:
76	The GNU texinfo and GNU info pages are not built and installed
77	anymore, WITH_INFO knob has been added to allow to built and install
78	them again.
79
8020140708:
81	The GNU readline library is now an INTERNALLIB - that is, it is
82	statically linked into consumers (GDB and variants) in the base
83	system, and the shared library is no longer installed.  The
84	devel/readline port is available for third party software that
85	requires readline.
86
8720140702:
88	The Itanium architecture (ia64) has been removed from the list of
89	known architectures. This is the first step in the removal of the
90	architecture.
91
9220140701:
93	Commit r268115 has added NFSv4.1 server support, merged from
94	projects/nfsv4.1-server.  Since this includes changes to the
95	internal interfaces between the NFS related modules, a full
96	build of the kernel and modules will be necessary.
97	__FreeBSD_version has been bumped.
98
9920140629:
100	The WITHOUT_VT_SUPPORT kernel config knob has been renamed
101	WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
102	which differs from the behaviour controlled by this knob.)
103
10420140619:
105	Maximal length of the serial number in CTL was increased from 16 to
106	64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
107	and ctld, need to be rebuilt to work with a new kernel.
108
10920140606:
110	The libatf-c and libatf-c++ major versions were downgraded to 0 and
111	1 respectively to match the upstream numbers.  They were out of
112	sync because, when they were originally added to FreeBSD, the
113	upstream versions were not respected.  These libraries are private
114	and not yet built by default, so renumbering them should be a
115	non-issue.  However, unclean source trees will yield broken test
116	programs once the operator executes "make delete-old-libs" after a
117	"make installworld".
118
119	Additionally, the atf-sh binary was made private by moving it into
120	/usr/libexec/.  Already-built shell test programs will keep the
121	path to the old binary so they will break after "make delete-old"
122	is run.
123
124	If you are using WITH_TESTS=yes (not the default), wipe the object
125	tree and rebuild from scratch to prevent spurious test failures.
126	This is only needed once: the misnumbered libraries and misplaced
127	binaries have been added to OptionalObsoleteFiles.inc so they will
128	be removed during a clean upgrade.
129
13020140512:
131	Clang and llvm have been upgraded to 3.4.1 release.
132
13320140508:
134	We bogusly installed src.opts.mk in /usr/share/mk. This file should
135	be removed to avoid issues in the future (and has been added to
136	ObsoleteFiles.inc).
137
13820140505:
139	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
140	past, it affected all builds that used the bsd.*.mk files. The old
141	behavior was a bug, but people may have relied upon it. To get this
142	behavior back, you can .include /etc/src.conf from /etc/make.conf
143	(which is still global and isn't changed). This also changes the
144	behavior of incremental builds inside the tree of individual
145	directories. Set MAKESYSPATH to ".../share/mk" to do that.
146	Although this has survived make universe and some upgrade scenarios,
147	other upgrade scenarios may have broken. At least one form of
148	temporary breakage was fixed with MAKESYSPATH settings for buildworld
149	as well... In cases where MAKESYSPATH isn't working with this
150	setting, you'll need to set it to the full path to your tree.
151
152	One side effect of all this cleaning up is that bsd.compiler.mk
153	is no longer implicitly included by bsd.own.mk. If you wish to
154	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
155	as well.
156
15720140430:
158	The lindev device has been removed since /dev/full has been made a
159	standard device.  __FreeBSD_version has been bumped.
160
16120140418:
162	The YES_HESIOD knob has been removed. It has been obsolete for
163	a decade. Please move to using WITH_HESIOD instead or your builds
164	will silently lack HESIOD.
165
16620140405:
167	The uart(4) driver has been changed with respect to its handling
168	of the low-level console. Previously the uart(4) driver prevented
169	any process from changing the baudrate or the CLOCAL and HUPCL
170	control flags. By removing the restrictions, operators can make
171	changes to the serial console port without having to reboot.
172	However, when getty(8) is started on the serial device that is
173	associated with the low-level console, a misconfigured terminal
174	line in /etc/ttys will now have a real impact.
175	Before upgrading the kernel, make sure that /etc/ttys has the
176	serial console device configured as 3wire without baudrate to
177	preserve the previous behaviour. E.g:
178	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
179
18020140306:
181	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
182	to improve performance.  To re-enable it, if needed, run rpcbind
183	with command line option -W.
184
18520140226:
186	Switched back to the GPL dtc compiler due to updates in the upstream
187	dts files not being supported by the BSDL dtc compiler. You will need
188	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
189	may result while building dtb files during a kernel build if you fail
190	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
191
19220140216:
193	Clang and llvm have been upgraded to 3.4 release.
194
19520140216:
196	The nve(4) driver has been removed.  Please use the nfe(4) driver
197	for NVIDIA nForce MCP Ethernet adapters instead.
198
19920140212:
200	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
201	This could cause certain C++ applications using shared libraries built
202	against the previous version of libc++ to crash.  The incompatibility
203	has now been fixed, but any C++ applications or shared libraries built
204	between r261283 and r261801 should be recompiled.
205
20620140204:
207	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
208	capability mode support.  Please note that enabling the feature in
209	kernel is still highly recommended.
210
21120140131:
212	OpenSSH is now built with sandbox support, and will use sandbox as
213	the default privilege separation method.  This requires Capsicum
214	capability mode support in kernel.
215
21620140128:
217	The libelf and libdwarf libraries have been updated to newer
218	versions from upstream. Shared library version numbers for
219	these two libraries were bumped. Any ports or binaries
220	requiring these two libraries should be recompiled.
221	__FreeBSD_version is bumped to 1100006.
222
22320140110:
224	If a Makefile in a tests/ directory was auto-generating a Kyuafile
225	instead of providing an explicit one, this would prevent such
226	Makefile from providing its own Kyuafile in the future during
227	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
228	intervention is needed to clean an objdir if you use NO_CLEAN:
229	  # find /usr/obj -name Kyuafile | xargs rm -f
230
23120131213:
232	The behavior of gss_pseudo_random() for the krb5 mechanism
233	has changed, for applications requesting a longer random string
234	than produced by the underlying enctype's pseudo-random() function.
235	In particular, the random string produced from a session key of
236	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
237	be different at the 17th octet and later, after this change.
238	The counter used in the PRF+ construction is now encoded as a
239	big-endian integer in accordance with RFC 4402.
240	__FreeBSD_version is bumped to 1100004.
241
24220131108:
243	The WITHOUT_ATF build knob has been removed and its functionality
244	has been subsumed into the more generic WITHOUT_TESTS.  If you were
245	using the former to disable the build of the ATF libraries, you
246	should change your settings to use the latter.
247
24820131025:
249	The default version of mtree is nmtree which is obtained from
250	NetBSD.  The output is generally the same, but may vary
251	slightly.  If you found you need identical output adding
252	"-F freebsd9" to the command line should do the trick.  For the
253	time being, the old mtree is available as fmtree.
254
25520131014:
256	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
257	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
258	1.1.4_8 and verify bsdyml not linked in, before running "make
259	delete-old-libs":
260	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
261	  or
262	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
263
26420131010:
265	The rc.d/jail script has been updated to support jail(8)
266	configuration file.  The "jail_<jname>_*" rc.conf(5) variables
267	for per-jail configuration are automatically converted to
268	/var/run/jail.<jname>.conf before the jail(8) utility is invoked.
269	This is transparently backward compatible.  See below about some
270	incompatibilities and rc.conf(5) manual page for more details.
271
272	These variables are now deprecated in favor of jail(8) configuration
273	file.  One can use "rc.d/jail config <jname>" command to generate
274	a jail(8) configuration file in /var/run/jail.<jname>.conf without
275	running the jail(8) utility.   The default pathname of the
276	configuration file is /etc/jail.conf and can be specified by
277	using $jail_conf or $jail_<jname>_conf variables.
278
279	Please note that jail_devfs_ruleset accepts an integer at
280	this moment.  Please consider to rewrite the ruleset name
281	with an integer.
282
28320130930:
284	BIND has been removed from the base system.  If all you need
285	is a local resolver, simply enable and start the local_unbound
286	service instead.  Otherwise, several versions of BIND are
287	available in the ports tree.   The dns/bind99 port is one example.
288
289	With this change, nslookup(1) and dig(1) are no longer in the base
290	system.  Users should instead use host(1) and drill(1) which are
291	in the base system.  Alternatively, nslookup and dig can
292	be obtained by installing the dns/bind-tools port.
293
29420130916:
295	With the addition of unbound(8), a new unbound user is now
296	required during installworld.  "mergemaster -p" can be used to
297	add the user prior to installworld, as documented in the handbook.
298
29920130911:
300	OpenSSH is now built with DNSSEC support, and will by default
301	silently trust signed SSHFP records.  This can be controlled with
302	the VerifyHostKeyDNS client configuration setting.  DNSSEC support
303	can be disabled entirely with the WITHOUT_LDNS option in src.conf.
304
30520130906:
306	The GNU Compiler Collection and C++ standard library (libstdc++)
307	are no longer built by default on platforms where clang is the system
308	compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
309	options in src.conf.
310
31120130905:
312	The PROCDESC kernel option is now part of the GENERIC kernel
313	configuration and is required for the rwhod(8) to work.
314	If you are using custom kernel configuration, you should include
315	'options PROCDESC'.
316
31720130905:
318	The API and ABI related to the Capsicum framework was modified
319	in backward incompatible way. The userland libraries and programs
320	have to be recompiled to work with the new kernel. This includes the
321	following libraries and programs, but the whole buildworld is
322	advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
323	kdump, procstat, rwho, rwhod, uniq.
324
32520130903:
326	AES-NI intrinsic support has been added to gcc.  The AES-NI module
327	has been updated to use this support.  A new gcc is required to build
328	the aesni module on both i386 and amd64.
329
33020130821:
331	The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
332	Thus "device padlock_rng" and "device rdrand_rng" should be
333	used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
334
33520130813:
336	WITH_ICONV has been split into two feature sets.  WITH_ICONV now
337	enables just the iconv* functionality and is now on by default.
338	WITH_LIBICONV_COMPAT enables the libiconv api and link time
339	compatability.  Set WITHOUT_ICONV to build the old way.
340	If you have been using WITH_ICONV before, you will very likely
341	need to turn on WITH_LIBICONV_COMPAT.
342
34320130806:
344	INVARIANTS option now enables DEBUG for code with OpenSolaris and
345	Illumos origin, including ZFS.  If you have INVARIANTS in your
346	kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
347	explicitly.
348	DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
349	locks if WITNESS option was set.  Because that generated a lot of
350	witness(9) reports and all of them were believed to be false
351	positives, this is no longer done.  New option OPENSOLARIS_WITNESS
352	can be used to achieve the previous behavior.
353
35420130806:
355	Timer values in IPv6 data structures now use time_uptime instead
356	of time_second.  Although this is not a user-visible functional
357	change, userland utilities which directly use them---ndp(8),
358	rtadvd(8), and rtsold(8) in the base system---need to be updated
359	to r253970 or later.
360
36120130802:
362	find -delete can now delete the pathnames given as arguments,
363	instead of only files found below them or if the pathname did
364	not contain any slashes. Formerly, the following error message
365	would result:
366
367	find: -delete: <path>: relative path potentially not safe
368
369	Deleting the pathnames given as arguments can be prevented
370	without error messages using -mindepth 1 or by changing
371	directory and passing "." as argument to find. This works in the
372	old as well as the new version of find.
373
37420130726:
375	Behavior of devfs rules path matching has been changed.
376	Pattern is now always matched against fully qualified devfs
377	path and slash characters must be explicitly matched by
378	slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
379	subdirectories must be reviewed.
380
38120130716:
382	The default ARM ABI has changed to the ARM EABI. The old ABI is
383	incompatible with the ARM EABI and all programs and modules will
384	need to be rebuilt to work with a new kernel.
385
386	To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
387
388	NOTE: Support for the old ABI will be removed in the future and
389	users are advised to upgrade.
390
39120130709:
392	pkg_install has been disconnected from the build if you really need it
393	you should add WITH_PKGTOOLS in your src.conf(5).
394
39520130709:
396	Most of network statistics structures were changed to be able
397	keep 64-bits counters. Thus all tools, that work with networking
398	statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
399
40020130629:
401	Fix targets that run multiple make's to use && rather than ;
402	so that subsequent steps depend on success of previous.
403
404	NOTE: if building 'universe' with -j* on stable/8 or stable/9
405	it would be better to start the build using bmake, to avoid
406	overloading the machine.
407
40820130618:
409	Fix a bug that allowed a tracing process (e.g. gdb) to write
410	to a memory-mapped file in the traced process's address space
411	even if neither the traced process nor the tracing process had
412	write access to that file.
413
41420130615:
415	CVS has been removed from the base system.  An exact copy
416	of the code is available from the devel/cvs port.
417
41820130613:
419	Some people report the following error after the switch to bmake:
420
421		make: illegal option -- J
422		usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
423			...
424		*** [buildworld] Error code 2
425
426	this likely due to an old instance of make in
427	${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
428	which src/Makefile will use that blindly, if it exists, so if
429	you see the above error:
430
431		rm -rf `make -V MAKEPATH`
432
433	should resolve it.
434
43520130516:
436	Use bmake by default.
437	Whereas before one could choose to build with bmake via
438	-DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
439	make. The goal is to remove these knobs for 10-RELEASE.
440
441	It is worth noting that bmake (like gmake) treats the command
442	line as the unit of failure, rather than statements within the
443	command line.  Thus '(cd some/where && dosomething)' is safer
444	than 'cd some/where; dosomething'. The '()' allows consistent
445	behavior in parallel build.
446
44720130429:
448        Fix a bug that allows NFS clients to issue READDIR on files.
449
45020130426:
451	The WITHOUT_IDEA option has been removed because
452	the IDEA patent expired.
453
45420130426:
455	The sysctl which controls TRIM support under ZFS has been renamed
456	from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
457	enabled by default.
458
45920130425:
460	The mergemaster command now uses the default MAKEOBJDIRPREFIX
461	rather than creating it's own in the temporary directory in
462	order allow access to bootstrapped versions of tools such as
463	install and mtree.  When upgrading from version of FreeBSD where
464	the install command does not support -l, you will need to
465	install a new mergemaster command if mergemaster -p is required.
466	This can be accomplished with the command (cd src/usr.sbin/mergemaster
467	&& make install).
468
46920130404:
470	Legacy ATA stack, disabled and replaced by new CAM-based one since
471	FreeBSD 9.0, completely removed from the sources.  Kernel modules
472	atadisk and atapi*, user-level tools atacontrol and burncd are
473	removed.  Kernel option `options ATA_CAM` is now permanently enabled
474	and removed.
475
47620130319:
477	SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
478	and socketpair(2). Software, in particular Kerberos, may
479	automatically detect and use these during building. The resulting
480	binaries will not work on older kernels.
481
48220130308:
483	CTL_DISABLE has also been added to the sparc64 GENERIC (for further
484	information, see the respective 20130304 entry).
485
48620130304:
487	Recent commits to callout(9) changed the size of struct callout,
488	so the KBI is probably heavily disturbed. Also, some functions
489	in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
490	by macros. Every kernel module using it won't load, so rebuild
491	is requested.
492
493	The ctl device has been re-enabled in GENERIC for i386 and amd64,
494	but does not initialize by default (because of the new CTL_DISABLE
495	option) to save memory.  To re-enable it, remove the CTL_DISABLE
496	option from the kernel config file or set kern.cam.ctl.disable=0
497	in /boot/loader.conf.
498
49920130301:
500	The ctl device has been disabled in GENERIC for i386 and amd64.
501	This was done due to the extra memory being allocated at system
502	initialisation time by the ctl driver which was only used if
503	a CAM target device was created.  This makes a FreeBSD system
504	unusable on 128MB or less of RAM.
505
50620130208:
507	A new compression method (lz4) has been merged to -HEAD.  Please
508	refer to zpool-features(7) for more information.
509
510	Please refer to the "ZFS notes" section of this file for information
511	on upgrading boot ZFS pools.
512
51320130129:
514	A BSD-licensed patch(1) variant has been added and is installed
515	as bsdpatch, being the GNU version the default patch.
516	To inverse the logic and use the BSD-licensed one as default,
517	while having the GNU version installed as gnupatch, rebuild
518	and install world with the WITH_BSD_PATCH knob set.
519
52020130121:
521	Due to the use of the new -l option to install(1) during build
522	and install, you must take care not to directly set the INSTALL
523	make variable in your /etc/make.conf, /etc/src.conf, or on the
524	command line.  If you wish to use the -C flag for all installs
525	you may be able to add INSTALL+=-C to /etc/make.conf or
526	/etc/src.conf.
527
52820130118:
529	The install(1) option -M has changed meaning and now takes an
530	argument that is a file or path to append logs to.  In the
531	unlikely event that -M was the last option on the command line
532	and the command line contained at least two files and a target
533	directory the first file will have logs appended to it.  The -M
534	option served little practical purpose in the last decade so its
535	use is expected to be extremely rare.
536
53720121223:
538	After switching to Clang as the default compiler some users of ZFS
539	on i386 systems started to experience stack overflow kernel panics.
540	Please consider using 'options KSTACK_PAGES=4' in such configurations.
541
54220121222:
543	GEOM_LABEL now mangles label names read from file system metadata.
544	Mangling affect labels containing spaces, non-printable characters,
545	'%' or '"'. Device names in /etc/fstab and other places may need to
546	be updated.
547
54820121217:
549	By default, only the 10 most recent kernel dumps will be saved.  To
550	restore the previous behaviour (no limit on the number of kernel dumps
551	stored in the dump directory) add the following line to /etc/rc.conf:
552
553		savecore_flags=""
554
55520121201:
556	With the addition of auditdistd(8), a new auditdistd user is now
557	required during installworld.  "mergemaster -p" can be used to
558	add the user prior to installworld, as documented in the handbook.
559
56020121117:
561	The sin6_scope_id member variable in struct sockaddr_in6 is now
562	filled by the kernel before passing the structure to the userland via
563	sysctl or routing socket.  This means the KAME-specific embedded scope
564	id in sin6_addr.s6_addr[2] is always cleared in userland application.
565	This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
566	__FreeBSD_version is bumped to 1000025.
567
56820121105:
569	On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
570	This means that the world and kernel will be compiled with clang
571	and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
572	and /usr/bin/cpp.  To disable this behavior and revert to building
573	with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
574	of current may need to bootstrap WITHOUT_CLANG first if the clang
575	build fails (its compatibility window doesn't extend to the 9 stable
576	branch point).
577
57820121102:
579	The IPFIREWALL_FORWARD kernel option has been removed. Its
580	functionality now turned on by default.
581
58220121023:
583	The ZERO_COPY_SOCKET kernel option has been removed and
584	split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
585	NB: SOCKET_SEND_COW uses the VM page based copy-on-write
586	mechanism which is not safe and may result in kernel crashes.
587	NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
588	driver supports disposeable external page sized mbuf storage.
589	Proper replacements for both zero-copy mechanisms are under
590	consideration and will eventually lead to complete removal
591	of the two kernel options.
592
59320121023:
594	The IPv4 network stack has been converted to network byte
595	order. The following modules need to be recompiled together
596	with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
597	pf(4), ipfw(4), ng_ipfw(4), stf(4).
598
59920121022:
600	Support for non-MPSAFE filesystems was removed from VFS. The
601	VFS_VERSION was bumped, all filesystem modules shall be
602	recompiled.
603
60420121018:
605	All the non-MPSAFE filesystems have been disconnected from
606	the build. The full list includes: codafs, hpfs, ntfs, nwfs,
607	portalfs, smbfs, xfs.
608
60920121016:
610	The interface cloning API and ABI has changed. The following
611	modules need to be recompiled together with kernel:
612	ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
613	vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
614	faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
615
61620121015:
617	The sdhci driver was split in two parts: sdhci (generic SD Host
618	Controller logic) and sdhci_pci (actual hardware driver).
619	No kernel config modifications are required, but if you
620	load sdhc as a module you must switch to sdhci_pci instead.
621
62220121014:
623	Import the FUSE kernel and userland support into base system.
624
62520121013:
626	The GNU sort(1) program has been removed since the BSD-licensed
627	sort(1) has been the default for quite some time and no serious
628	problems have been reported.  The corresponding WITH_GNU_SORT
629	knob has also gone.
630
63120121006:
632	The pfil(9) API/ABI for AF_INET family has been changed. Packet
633	filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
634	with new kernel.
635
63620121001:
637	The net80211(4) ABI has been changed to allow for improved driver
638	PS-POLL and power-save support.  All wireless drivers need to be
639	recompiled to work with the new kernel.
640
64120120913:
642	The random(4) support for the VIA hardware random number
643	generator (`PADLOCK') is no longer enabled unconditionally.
644	Add the padlock_rng device in the custom kernel config if
645	needed.  The GENERIC kernels on i386 and amd64 do include the
646	device, so the change only affects the custom kernel
647	configurations.
648
64920120908:
650	The pf(4) packet filter ABI has been changed. pfctl(8) and
651	snmp_pf module need to be recompiled to work with new kernel.
652
65320120828:
654	A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
655	to -HEAD. Pools that have empty_bpobj in active state can not be
656	imported read-write with ZFS implementations that do not support
657	this feature. For more information read the zpool-features(5)
658	manual page.
659
66020120727:
661	The sparc64 ZFS loader has been changed to no longer try to auto-
662	detect ZFS providers based on diskN aliases but now requires these
663	to be explicitly listed in the OFW boot-device environment variable.
664
66520120712:
666	The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
667	libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
668	configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
669
67020120712:
671	The following sysctls and tunables have been renamed for consistency
672	with other variables:
673	  kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
674	  kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
675
67620120628:
677	The sort utility has been replaced with BSD sort.  For now, GNU sort
678	is also available as "gnusort" or the default can be set back to
679	GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
680	installed as "bsdsort".
681
68220120611:
683	A new version of ZFS (pool version 5000) has been merged to -HEAD.
684	Starting with this version the old system of ZFS pool versioning
685	is superseded by "feature flags". This concept enables forward
686	compatibility against certain future changes in functionality of ZFS
687	pools. The first read-only compatible "feature flag" for ZFS pools
688	is named "com.delphix:async_destroy". For more information
689	read the new zpool-features(5) manual page.
690	Please refer to the "ZFS notes" section of this file for information
691	on upgrading boot ZFS pools.
692
69320120417:
694	The malloc(3) implementation embedded in libc now uses sources imported
695	as contrib/jemalloc.  The most disruptive API change is to
696	/etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
697	delete it prior to installworld, and optionally re-create it using the
698	new format after rebooting.  See malloc.conf(5) for details
699	(specifically the TUNING section and the "opt.*" entries in the MALLCTL
700	NAMESPACE section).
701
70220120328:
703	Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
704	is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
705	now spelled mips.  This is to aid compatibility with third-party
706	software that expects this naming scheme in uname(3).  Little-endian
707	settings are unchanged. If you are updating a big-endian mips64 machine
708	from before this change, you may need to set MACHINE_ARCH=mips64 in
709	your environment before the new build system will recognize your machine.
710
71120120306:
712	Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
713	platforms.
714
71520120229:
716	Now unix domain sockets behave "as expected" on	nullfs(5). Previously
717	nullfs(5) did not pass through all behaviours to the underlying layer,
718	as a result if we bound to a socket on the lower layer we could connect
719	only to the lower path; if we bound to the upper layer we could connect
720	only to	the upper path. The new behavior is one can connect to both the
721	lower and the upper paths regardless what layer path one binds to.
722
72320120211:
724	The getifaddrs upgrade path broken with 20111215 has been restored.
725	If you have upgraded in between 20111215 and 20120209 you need to
726	recompile libc again with your kernel.  You still need to recompile
727	world to be able to configure CARP but this restriction already
728	comes from 20111215.
729
73020120114:
731	The set_rcvar() function has been removed from /etc/rc.subr.  All
732	base and ports rc.d scripts have been updated, so if you have a
733	port installed with a script in /usr/local/etc/rc.d you can either
734	hand-edit the rcvar= line, or reinstall the port.
735
736	An easy way to handle the mass-update of /etc/rc.d:
737	rm /etc/rc.d/* && mergemaster -i
738
73920120109:
740	panic(9) now stops other CPUs in the SMP systems, disables interrupts
741	on the current CPU and prevents other threads from running.
742	This behavior can be reverted using the kern.stop_scheduler_on_panic
743	tunable/sysctl.
744	The new behavior can be incompatible with kern.sync_on_panic.
745
74620111215:
747	The carp(4) facility has been changed significantly. Configuration
748	of the CARP protocol via ifconfig(8) has changed, as well as format
749	of CARP events submitted to devd(8) has changed. See manual pages
750	for more information. The arpbalance feature of carp(4) is currently
751	not supported anymore.
752
753	Size of struct in_aliasreq, struct in6_aliasreq has changed. User
754	utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
755	need to be recompiled.
756
75720111122:
758	The acpi_wmi(4) status device /dev/wmistat has been renamed to
759	/dev/wmistat0.
760
76120111108:
762	The option VFS_ALLOW_NONMPSAFE option has been added in order to
763	explicitely support non-MPSAFE filesystems.
764	It is on by default for all supported platform at this present
765	time.
766
76720111101:
768	The broken amd(4) driver has been replaced with esp(4) in the amd64,
769	i386 and pc98 GENERIC kernel configuration files.
770
77120110930:
772	sysinstall has been removed
773
77420110923:
775	The stable/9 branch created in subversion.  This corresponds to the
776	RELENG_9 branch in CVS.
777
778COMMON ITEMS:
779
780	General Notes
781	-------------
782	Avoid using make -j when upgrading.  While generally safe, there are
783	sometimes problems using -j to upgrade.  If your upgrade fails with
784	-j, please try again without -j.  From time to time in the past there
785	have been problems using -j with buildworld and/or installworld.  This
786	is especially true when upgrading between "distant" versions (eg one
787	that cross a major release boundary or several minor releases, or when
788	several months have passed on the -current branch).
789
790	Sometimes, obscure build problems are the result of environment
791	poisoning.  This can happen because the make utility reads its
792	environment when searching for values for global variables.  To run
793	your build attempts in an "environmental clean room", prefix all make
794	commands with 'env -i '.  See the env(1) manual page for more details.
795
796	When upgrading from one major version to another it is generally best
797	to upgrade to the latest code in the currently installed branch first,
798	then do an upgrade to the new branch. This is the best-tested upgrade
799	path, and has the highest probability of being successful.  Please try
800	this approach before reporting problems with a major version upgrade.
801
802	When upgrading a live system, having a root shell around before
803	installing anything can help undo problems. Not having a root shell
804	around can lead to problems if pam has changed too much from your
805	starting point to allow continued authentication after the upgrade.
806
807	ZFS notes
808	---------
809	When upgrading the boot ZFS pool to a new version, always follow
810	these two steps:
811
812	1.) recompile and reinstall the ZFS boot loader and boot block
813	(this is part of "make buildworld" and "make installworld")
814
815	2.) update the ZFS boot block on your boot drive
816
817	The following example updates the ZFS boot block on the first
818	partition (freebsd-boot) of a GPT partitioned drive ad0:
819	"gpart bootcode -p /boot/gptzfsboot -i 1 ad0"
820
821	Non-boot pools do not need these updates.
822
823	To build a kernel
824	-----------------
825	If you are updating from a prior version of FreeBSD (even one just
826	a few days old), you should follow this procedure.  It is the most
827	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
828
829	make kernel-toolchain
830	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
831	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
832
833	To test a kernel once
834	---------------------
835	If you just want to boot a kernel once (because you are not sure
836	if it works, or if you want to boot a known bad kernel to provide
837	debugging information) run
838	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
839	nextboot -k testkernel
840
841	To just build a kernel when you know that it won't mess you up
842	--------------------------------------------------------------
843	This assumes you are already running a CURRENT system.  Replace
844	${arch} with the architecture of your machine (e.g. "i386",
845	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
846
847	cd src/sys/${arch}/conf
848	config KERNEL_NAME_HERE
849	cd ../compile/KERNEL_NAME_HERE
850	make depend
851	make
852	make install
853
854	If this fails, go to the "To build a kernel" section.
855
856	To rebuild everything and install it on the current system.
857	-----------------------------------------------------------
858	# Note: sometimes if you are running current you gotta do more than
859	# is listed here if you are upgrading from a really old current.
860
861	<make sure you have good level 0 dumps>
862	make buildworld
863	make kernel KERNCONF=YOUR_KERNEL_HERE
864							[1]
865	<reboot in single user>				[3]
866	mergemaster -Fp					[5]
867	make installworld
868	mergemaster -Fi					[4]
869	make delete-old					[6]
870	<reboot>
871
872	To cross-install current onto a separate partition
873	--------------------------------------------------
874	# In this approach we use a separate partition to hold
875	# current's root, 'usr', and 'var' directories.   A partition
876	# holding "/", "/usr" and "/var" should be about 2GB in
877	# size.
878
879	<make sure you have good level 0 dumps>
880	<boot into -stable>
881	make buildworld
882	make buildkernel KERNCONF=YOUR_KERNEL_HERE
883	<maybe newfs current's root partition>
884	<mount current's root partition on directory ${CURRENT_ROOT}>
885	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
886	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
887	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
888	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
889	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
890	<reboot into current>
891	<do a "native" rebuild/install as described in the previous section>
892	<maybe install compatibility libraries from ports/misc/compat*>
893	<reboot>
894
895
896	To upgrade in-place from stable to current
897	----------------------------------------------
898	<make sure you have good level 0 dumps>
899	make buildworld					[9]
900	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
901							[1]
902	<reboot in single user>				[3]
903	mergemaster -Fp					[5]
904	make installworld
905	mergemaster -Fi					[4]
906	make delete-old					[6]
907	<reboot>
908
909	Make sure that you've read the UPDATING file to understand the
910	tweaks to various things you need.  At this point in the life
911	cycle of current, things change often and you are on your own
912	to cope.  The defaults can also change, so please read ALL of
913	the UPDATING entries.
914
915	Also, if you are tracking -current, you must be subscribed to
916	freebsd-current@freebsd.org.  Make sure that before you update
917	your sources that you have read and understood all the recent
918	messages there.  If in doubt, please track -stable which has
919	much fewer pitfalls.
920
921	[1] If you have third party modules, such as vmware, you
922	should disable them at this point so they don't crash your
923	system on reboot.
924
925	[3] From the bootblocks, boot -s, and then do
926		fsck -p
927		mount -u /
928		mount -a
929		cd src
930		adjkerntz -i		# if CMOS is wall time
931	Also, when doing a major release upgrade, it is required that
932	you boot into single user mode to do the installworld.
933
934	[4] Note: This step is non-optional.  Failure to do this step
935	can result in a significant reduction in the functionality of the
936	system.  Attempting to do it by hand is not recommended and those
937	that pursue this avenue should read this file carefully, as well
938	as the archives of freebsd-current and freebsd-hackers mailing lists
939	for potential gotchas.  The -U option is also useful to consider.
940	See mergemaster(8) for more information.
941
942	[5] Usually this step is a noop.  However, from time to time
943	you may need to do this if you get unknown user in the following
944	step.  It never hurts to do it all the time.  You may need to
945	install a new mergemaster (cd src/usr.sbin/mergemaster && make
946	install) after the buildworld before this step if you last updated
947	from current before 20130425 or from -stable before 20130430.
948
949	[6] This only deletes old files and directories. Old libraries
950	can be deleted by "make delete-old-libs", but you have to make
951	sure that no program is using those libraries anymore.
952
953	[8] In order to have a kernel that can run the 4.x binaries needed to
954	do an installworld, you must include the COMPAT_FREEBSD4 option in
955	your kernel.  Failure to do so may leave you with a system that is
956	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
957	required to run the 5.x binaries on more recent kernels.  And so on
958	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
959
960	Make sure that you merge any new devices from GENERIC since the
961	last time you updated your kernel config file.
962
963	[9] When checking out sources, you must include the -P flag to have
964	cvs prune empty directories.
965
966	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
967	"?=" instead of the "=" assignment operator, so that buildworld can
968	override the CPUTYPE if it needs to.
969
970	MAKEOBJDIRPREFIX must be defined in an environment variable, and
971	not on the command line, or in /etc/make.conf.  buildworld will
972	warn if it is improperly defined.
973FORMAT:
974
975This file contains a list, in reverse chronological order, of major
976breakages in tracking -current.  It is not guaranteed to be a complete
977list of such breakages, and only contains entries since October 10, 2007.
978If you need to see UPDATING entries from before that date, you will need
979to fetch an UPDATING file from an older FreeBSD release.
980
981Copyright information:
982
983Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
984
985Redistribution, publication, translation and use, with or without
986modification, in full or in part, in any form or format of this
987document are permitted without further permission from the author.
988
989THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
990IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
991WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
992DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
993INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
994(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
995SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
996HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
997STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
998IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
999POSSIBILITY OF SUCH DAMAGE.
1000
1001Contact Warner Losh if you have any questions about your use of
1002this document.
1003
1004$FreeBSD$
1005