xref: /freebsd/UPDATING (revision fae50821ae22099d0406090228bc4c5b6af693ad)
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
3420140508:
35	We bogusly installed src.opts.mk in /usr/share/mk. This file should
36	be removed to avoid issues in the future (and has been added to
37	ObsoleteFiles.inc).
38
3920140505:
40	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
41	past, it affected all builds that used the bsd.*.mk files. The old
42	behavior was a bug, but people may have relied upon it. To get this
43	behavior back, you can .include /etc/src.conf from /etc/make.conf
44	(which is still global and isn't changed). This also changes the
45	behavior of incremental builds inside the tree of individual
46	directories. Set MAKESYSPATH to ".../share/mk" to do that.
47	Although this has survived make universe and some upgrade scenarios,
48	other upgrade scenarios may have broken. At least one form of
49	temporary breakage was fixed with MAKESYSPATH settings for buildworld
50	as well...
51
52	One side effect of all this cleaning up is that bsd.compiler.mk
53	is no longer implicitly included by bsd.own.mk. If you wish to
54	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
55	as well.
56
5720140430:
58	The lindev device has been removed since /dev/full has been made a
59	standard device.  __FreeBSD_version has been bumped.
60
6120140418:
62	The YES_HESIOD knob has been removed. It has been obsolete for
63	a decade. Please move to using WITH_HESIOD instead or your builds
64	will silently lack HESIOD.
65
6620140405:
67	The uart(4) driver has been changed with respect to its handling
68	of the low-level console. Previously the uart(4) driver prevented
69	any process from changing the baudrate or the CLOCAL and HUPCL
70	control flags. By removing the restrictions, operators can make
71	changes to the serial console port without having to reboot.
72	However, when getty(8) is started on the serial device that is
73	associated with the low-level console, a misconfigured terminal
74	line in /etc/ttys will now have a real impact.
75	Before upgrading the kernel, make sure that /etc/ttys has the
76	serial console device configured as 3wire without baudrate to
77	preserve the previous behaviour. E.g:
78	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
79
8020140306:
81	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
82	to improve performance.  To re-enable it, if needed, run rpcbind
83	with command line option -W.
84
8520140226:
86	Switched back to the GPL dtc compiler due to updates in the upstream
87	dts files not being supported by the BSDL dtc compiler. You will need
88	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
89	may result while building dtb files during a kernel build if you fail
90	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
91
9220140216:
93	Clang and llvm have been upgraded to 3.4 release.
94
9520140216:
96	The nve(4) driver has been removed.  Please use the nfe(4) driver
97	for NVIDIA nForce MCP Ethernet adapters instead.
98
9920140212:
100	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
101	This could cause certain C++ applications using shared libraries built
102	against the previous version of libc++ to crash.  The incompatibility
103	has now been fixed, but any C++ applications or shared libraries built
104	between r261283 and r261801 should be recompiled.
105
10620140204:
107	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
108	capability mode support.  Please note that enabling the feature in
109	kernel is still highly recommended.
110
11120140131:
112	OpenSSH is now built with sandbox support, and will use sandbox as
113	the default privilege separation method.  This requires Capsicum
114	capability mode support in kernel.
115
11620140128:
117	The libelf and libdwarf libraries have been updated to newer
118	versions from upstream. Shared library version numbers for
119	these two libraries were bumped. Any ports or binaries
120	requiring these two libraries should be recompiled.
121	__FreeBSD_version is bumped to 1100006.
122
12320140110:
124	If a Makefile in a tests/ directory was auto-generating a Kyuafile
125	instead of providing an explicit one, this would prevent such
126	Makefile from providing its own Kyuafile in the future during
127	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
128	intervention is needed to clean an objdir if you use NO_CLEAN:
129	  # find /usr/obj -name Kyuafile | xargs rm -f
130
13120131213:
132	The behavior of gss_pseudo_random() for the krb5 mechanism
133	has changed, for applications requesting a longer random string
134	than produced by the underlying enctype's pseudo-random() function.
135	In particular, the random string produced from a session key of
136	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
137	be different at the 17th octet and later, after this change.
138	The counter used in the PRF+ construction is now encoded as a
139	big-endian integer in accordance with RFC 4402.
140	__FreeBSD_version is bumped to 1100004.
141
14220131108:
143	The WITHOUT_ATF build knob has been removed and its functionality
144	has been subsumed into the more generic WITHOUT_TESTS.  If you were
145	using the former to disable the build of the ATF libraries, you
146	should change your settings to use the latter.
147
14820131025:
149	The default version of mtree is nmtree which is obtained from
150	NetBSD.  The output is generally the same, but may vary
151	slightly.  If you found you need identical output adding
152	"-F freebsd9" to the command line should do the trick.  For the
153	time being, the old mtree is available as fmtree.
154
15520131014:
156	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
157	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
158	1.1.4_8 and verify bsdyml not linked in, before running "make
159	delete-old-libs":
160	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
161	  or
162	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
163
16420131010:
165	The rc.d/jail script has been updated to support jail(8)
166	configuration file.  The "jail_<jname>_*" rc.conf(5) variables
167	for per-jail configuration are automatically converted to
168	/var/run/jail.<jname>.conf before the jail(8) utility is invoked.
169	This is transparently backward compatible.  See below about some
170	incompatibilities and rc.conf(5) manual page for more details.
171
172	These variables are now deprecated in favor of jail(8) configuration
173	file.  One can use "rc.d/jail config <jname>" command to generate
174	a jail(8) configuration file in /var/run/jail.<jname>.conf without
175	running the jail(8) utility.   The default pathname of the
176	configuration file is /etc/jail.conf and can be specified by
177	using $jail_conf or $jail_<jname>_conf variables.
178
179	Please note that jail_devfs_ruleset accepts an integer at
180	this moment.  Please consider to rewrite the ruleset name
181	with an integer.
182
18320130930:
184	BIND has been removed from the base system.  If all you need
185	is a local resolver, simply enable and start the local_unbound
186	service instead.  Otherwise, several versions of BIND are
187	available in the ports tree.   The dns/bind99 port is one example.
188
189	With this change, nslookup(1) and dig(1) are no longer in the base
190	system.  Users should instead use host(1) and drill(1) which are
191	in the base system.  Alternatively, nslookup and dig can
192	be obtained by installing the dns/bind-tools port.
193
19420130916:
195	With the addition of unbound(8), a new unbound user is now
196	required during installworld.  "mergemaster -p" can be used to
197	add the user prior to installworld, as documented in the handbook.
198
19920130911:
200	OpenSSH is now built with DNSSEC support, and will by default
201	silently trust signed SSHFP records.  This can be controlled with
202	the VerifyHostKeyDNS client configuration setting.  DNSSEC support
203	can be disabled entirely with the WITHOUT_LDNS option in src.conf.
204
20520130906:
206	The GNU Compiler Collection and C++ standard library (libstdc++)
207	are no longer built by default on platforms where clang is the system
208	compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
209	options in src.conf.
210
21120130905:
212	The PROCDESC kernel option is now part of the GENERIC kernel
213	configuration and is required for the rwhod(8) to work.
214	If you are using custom kernel configuration, you should include
215	'options PROCDESC'.
216
21720130905:
218	The API and ABI related to the Capsicum framework was modified
219	in backward incompatible way. The userland libraries and programs
220	have to be recompiled to work with the new kernel. This includes the
221	following libraries and programs, but the whole buildworld is
222	advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
223	kdump, procstat, rwho, rwhod, uniq.
224
22520130903:
226	AES-NI intrinsic support has been added to gcc.  The AES-NI module
227	has been updated to use this support.  A new gcc is required to build
228	the aesni module on both i386 and amd64.
229
23020130821:
231	The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
232	Thus "device padlock_rng" and "device rdrand_rng" should be
233	used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
234
23520130813:
236	WITH_ICONV has been split into two feature sets.  WITH_ICONV now
237	enables just the iconv* functionality and is now on by default.
238	WITH_LIBICONV_COMPAT enables the libiconv api and link time
239	compatability.  Set WITHOUT_ICONV to build the old way.
240	If you have been using WITH_ICONV before, you will very likely
241	need to turn on WITH_LIBICONV_COMPAT.
242
24320130806:
244	INVARIANTS option now enables DEBUG for code with OpenSolaris and
245	Illumos origin, including ZFS.  If you have INVARIANTS in your
246	kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
247	explicitly.
248	DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
249	locks if WITNESS option was set.  Because that generated a lot of
250	witness(9) reports and all of them were believed to be false
251	positives, this is no longer done.  New option OPENSOLARIS_WITNESS
252	can be used to achieve the previous behavior.
253
25420130806:
255	Timer values in IPv6 data structures now use time_uptime instead
256	of time_second.  Although this is not a user-visible functional
257	change, userland utilities which directly use them---ndp(8),
258	rtadvd(8), and rtsold(8) in the base system---need to be updated
259	to r253970 or later.
260
26120130802:
262	find -delete can now delete the pathnames given as arguments,
263	instead of only files found below them or if the pathname did
264	not contain any slashes. Formerly, the following error message
265	would result:
266
267	find: -delete: <path>: relative path potentially not safe
268
269	Deleting the pathnames given as arguments can be prevented
270	without error messages using -mindepth 1 or by changing
271	directory and passing "." as argument to find. This works in the
272	old as well as the new version of find.
273
27420130726:
275	Behavior of devfs rules path matching has been changed.
276	Pattern is now always matched against fully qualified devfs
277	path and slash characters must be explicitly matched by
278	slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
279	subdirectories must be reviewed.
280
28120130716:
282	The default ARM ABI has changed to the ARM EABI. The old ABI is
283	incompatible with the ARM EABI and all programs and modules will
284	need to be rebuilt to work with a new kernel.
285
286	To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
287
288	NOTE: Support for the old ABI will be removed in the future and
289	users are advised to upgrade.
290
29120130709:
292	pkg_install has been disconnected from the build if you really need it
293	you should add WITH_PKGTOOLS in your src.conf(5).
294
29520130709:
296	Most of network statistics structures were changed to be able
297	keep 64-bits counters. Thus all tools, that work with networking
298	statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
299
30020130629:
301	Fix targets that run multiple make's to use && rather than ;
302	so that subsequent steps depend on success of previous.
303
304	NOTE: if building 'universe' with -j* on stable/8 or stable/9
305	it would be better to start the build using bmake, to avoid
306	overloading the machine.
307
30820130618:
309	Fix a bug that allowed a tracing process (e.g. gdb) to write
310	to a memory-mapped file in the traced process's address space
311	even if neither the traced process nor the tracing process had
312	write access to that file.
313
31420130615:
315	CVS has been removed from the base system.  An exact copy
316	of the code is available from the devel/cvs port.
317
31820130613:
319	Some people report the following error after the switch to bmake:
320
321		make: illegal option -- J
322		usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
323			...
324		*** [buildworld] Error code 2
325
326	this likely due to an old instance of make in
327	${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
328	which src/Makefile will use that blindly, if it exists, so if
329	you see the above error:
330
331		rm -rf `make -V MAKEPATH`
332
333	should resolve it.
334
33520130516:
336	Use bmake by default.
337	Whereas before one could choose to build with bmake via
338	-DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
339	make. The goal is to remove these knobs for 10-RELEASE.
340
341	It is worth noting that bmake (like gmake) treats the command
342	line as the unit of failure, rather than statements within the
343	command line.  Thus '(cd some/where && dosomething)' is safer
344	than 'cd some/where; dosomething'. The '()' allows consistent
345	behavior in parallel build.
346
34720130429:
348        Fix a bug that allows NFS clients to issue READDIR on files.
349
35020130426:
351	The WITHOUT_IDEA option has been removed because
352	the IDEA patent expired.
353
35420130426:
355	The sysctl which controls TRIM support under ZFS has been renamed
356	from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
357	enabled by default.
358
35920130425:
360	The mergemaster command now uses the default MAKEOBJDIRPREFIX
361	rather than creating it's own in the temporary directory in
362	order allow access to bootstrapped versions of tools such as
363	install and mtree.  When upgrading from version of FreeBSD where
364	the install command does not support -l, you will need to
365	install a new mergemaster command if mergemaster -p is required.
366	This can be accomplished with the command (cd src/usr.sbin/mergemaster
367	&& make install).
368
36920130404:
370	Legacy ATA stack, disabled and replaced by new CAM-based one since
371	FreeBSD 9.0, completely removed from the sources.  Kernel modules
372	atadisk and atapi*, user-level tools atacontrol and burncd are
373	removed.  Kernel option `options ATA_CAM` is now permanently enabled
374	and removed.
375
37620130319:
377	SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
378	and socketpair(2). Software, in particular Kerberos, may
379	automatically detect and use these during building. The resulting
380	binaries will not work on older kernels.
381
38220130308:
383	CTL_DISABLE has also been added to the sparc64 GENERIC (for further
384	information, see the respective 20130304 entry).
385
38620130304:
387	Recent commits to callout(9) changed the size of struct callout,
388	so the KBI is probably heavily disturbed. Also, some functions
389	in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
390	by macros. Every kernel module using it won't load, so rebuild
391	is requested.
392
393	The ctl device has been re-enabled in GENERIC for i386 and amd64,
394	but does not initialize by default (because of the new CTL_DISABLE
395	option) to save memory.  To re-enable it, remove the CTL_DISABLE
396	option from the kernel config file or set kern.cam.ctl.disable=0
397	in /boot/loader.conf.
398
39920130301:
400	The ctl device has been disabled in GENERIC for i386 and amd64.
401	This was done due to the extra memory being allocated at system
402	initialisation time by the ctl driver which was only used if
403	a CAM target device was created.  This makes a FreeBSD system
404	unusable on 128MB or less of RAM.
405
40620130208:
407	A new compression method (lz4) has been merged to -HEAD.  Please
408	refer to zpool-features(7) for more information.
409
410	Please refer to the "ZFS notes" section of this file for information
411	on upgrading boot ZFS pools.
412
41320130129:
414	A BSD-licensed patch(1) variant has been added and is installed
415	as bsdpatch, being the GNU version the default patch.
416	To inverse the logic and use the BSD-licensed one as default,
417	while having the GNU version installed as gnupatch, rebuild
418	and install world with the WITH_BSD_PATCH knob set.
419
42020130121:
421	Due to the use of the new -l option to install(1) during build
422	and install, you must take care not to directly set the INSTALL
423	make variable in your /etc/make.conf, /etc/src.conf, or on the
424	command line.  If you wish to use the -C flag for all installs
425	you may be able to add INSTALL+=-C to /etc/make.conf or
426	/etc/src.conf.
427
42820130118:
429	The install(1) option -M has changed meaning and now takes an
430	argument that is a file or path to append logs to.  In the
431	unlikely event that -M was the last option on the command line
432	and the command line contained at least two files and a target
433	directory the first file will have logs appended to it.  The -M
434	option served little practical purpose in the last decade so its
435	use is expected to be extremely rare.
436
43720121223:
438	After switching to Clang as the default compiler some users of ZFS
439	on i386 systems started to experience stack overflow kernel panics.
440	Please consider using 'options KSTACK_PAGES=4' in such configurations.
441
44220121222:
443	GEOM_LABEL now mangles label names read from file system metadata.
444	Mangling affect labels containing spaces, non-printable characters,
445	'%' or '"'. Device names in /etc/fstab and other places may need to
446	be updated.
447
44820121217:
449	By default, only the 10 most recent kernel dumps will be saved.  To
450	restore the previous behaviour (no limit on the number of kernel dumps
451	stored in the dump directory) add the following line to /etc/rc.conf:
452
453		savecore_flags=""
454
45520121201:
456	With the addition of auditdistd(8), a new auditdistd user is now
457	required during installworld.  "mergemaster -p" can be used to
458	add the user prior to installworld, as documented in the handbook.
459
46020121117:
461	The sin6_scope_id member variable in struct sockaddr_in6 is now
462	filled by the kernel before passing the structure to the userland via
463	sysctl or routing socket.  This means the KAME-specific embedded scope
464	id in sin6_addr.s6_addr[2] is always cleared in userland application.
465	This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
466	__FreeBSD_version is bumped to 1000025.
467
46820121105:
469	On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
470	This means that the world and kernel will be compiled with clang
471	and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
472	and /usr/bin/cpp.  To disable this behavior and revert to building
473	with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
474	of current may need to bootstrap WITHOUT_CLANG first if the clang
475	build fails (its compatibility window doesn't extend to the 9 stable
476	branch point).
477
47820121102:
479	The IPFIREWALL_FORWARD kernel option has been removed. Its
480	functionality now turned on by default.
481
48220121023:
483	The ZERO_COPY_SOCKET kernel option has been removed and
484	split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
485	NB: SOCKET_SEND_COW uses the VM page based copy-on-write
486	mechanism which is not safe and may result in kernel crashes.
487	NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
488	driver supports disposeable external page sized mbuf storage.
489	Proper replacements for both zero-copy mechanisms are under
490	consideration and will eventually lead to complete removal
491	of the two kernel options.
492
49320121023:
494	The IPv4 network stack has been converted to network byte
495	order. The following modules need to be recompiled together
496	with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
497	pf(4), ipfw(4), ng_ipfw(4), stf(4).
498
49920121022:
500	Support for non-MPSAFE filesystems was removed from VFS. The
501	VFS_VERSION was bumped, all filesystem modules shall be
502	recompiled.
503
50420121018:
505	All the non-MPSAFE filesystems have been disconnected from
506	the build. The full list includes: codafs, hpfs, ntfs, nwfs,
507	portalfs, smbfs, xfs.
508
50920121016:
510	The interface cloning API and ABI has changed. The following
511	modules need to be recompiled together with kernel:
512	ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
513	vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
514	faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
515
51620121015:
517	The sdhci driver was split in two parts: sdhci (generic SD Host
518	Controller logic) and sdhci_pci (actual hardware driver).
519	No kernel config modifications are required, but if you
520	load sdhc as a module you must switch to sdhci_pci instead.
521
52220121014:
523	Import the FUSE kernel and userland support into base system.
524
52520121013:
526	The GNU sort(1) program has been removed since the BSD-licensed
527	sort(1) has been the default for quite some time and no serious
528	problems have been reported.  The corresponding WITH_GNU_SORT
529	knob has also gone.
530
53120121006:
532	The pfil(9) API/ABI for AF_INET family has been changed. Packet
533	filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
534	with new kernel.
535
53620121001:
537	The net80211(4) ABI has been changed to allow for improved driver
538	PS-POLL and power-save support.  All wireless drivers need to be
539	recompiled to work with the new kernel.
540
54120120913:
542	The random(4) support for the VIA hardware random number
543	generator (`PADLOCK') is no longer enabled unconditionally.
544	Add the padlock_rng device in the custom kernel config if
545	needed.  The GENERIC kernels on i386 and amd64 do include the
546	device, so the change only affects the custom kernel
547	configurations.
548
54920120908:
550	The pf(4) packet filter ABI has been changed. pfctl(8) and
551	snmp_pf module need to be recompiled to work with new kernel.
552
55320120828:
554	A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
555	to -HEAD. Pools that have empty_bpobj in active state can not be
556	imported read-write with ZFS implementations that do not support
557	this feature. For more information read the zpool-features(5)
558	manual page.
559
56020120727:
561	The sparc64 ZFS loader has been changed to no longer try to auto-
562	detect ZFS providers based on diskN aliases but now requires these
563	to be explicitly listed in the OFW boot-device environment variable.
564
56520120712:
566	The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
567	libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
568	configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
569
57020120712:
571	The following sysctls and tunables have been renamed for consistency
572	with other variables:
573	  kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
574	  kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
575
57620120628:
577	The sort utility has been replaced with BSD sort.  For now, GNU sort
578	is also available as "gnusort" or the default can be set back to
579	GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
580	installed as "bsdsort".
581
58220120611:
583	A new version of ZFS (pool version 5000) has been merged to -HEAD.
584	Starting with this version the old system of ZFS pool versioning
585	is superseded by "feature flags". This concept enables forward
586	compatibility against certain future changes in functionality of ZFS
587	pools. The first read-only compatible "feature flag" for ZFS pools
588	is named "com.delphix:async_destroy". For more information
589	read the new zpool-features(5) manual page.
590	Please refer to the "ZFS notes" section of this file for information
591	on upgrading boot ZFS pools.
592
59320120417:
594	The malloc(3) implementation embedded in libc now uses sources imported
595	as contrib/jemalloc.  The most disruptive API change is to
596	/etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
597	delete it prior to installworld, and optionally re-create it using the
598	new format after rebooting.  See malloc.conf(5) for details
599	(specifically the TUNING section and the "opt.*" entries in the MALLCTL
600	NAMESPACE section).
601
60220120328:
603	Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
604	is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
605	now spelled mips.  This is to aid compatibility with third-party
606	software that expects this naming scheme in uname(3).  Little-endian
607	settings are unchanged. If you are updating a big-endian mips64 machine
608	from before this change, you may need to set MACHINE_ARCH=mips64 in
609	your environment before the new build system will recognize your machine.
610
61120120306:
612	Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
613	platforms.
614
61520120229:
616	Now unix domain sockets behave "as expected" on	nullfs(5). Previously
617	nullfs(5) did not pass through all behaviours to the underlying layer,
618	as a result if we bound to a socket on the lower layer we could connect
619	only to the lower path; if we bound to the upper layer we could connect
620	only to	the upper path. The new behavior is one can connect to both the
621	lower and the upper paths regardless what layer path one binds to.
622
62320120211:
624	The getifaddrs upgrade path broken with 20111215 has been restored.
625	If you have upgraded in between 20111215 and 20120209 you need to
626	recompile libc again with your kernel.  You still need to recompile
627	world to be able to configure CARP but this restriction already
628	comes from 20111215.
629
63020120114:
631	The set_rcvar() function has been removed from /etc/rc.subr.  All
632	base and ports rc.d scripts have been updated, so if you have a
633	port installed with a script in /usr/local/etc/rc.d you can either
634	hand-edit the rcvar= line, or reinstall the port.
635
636	An easy way to handle the mass-update of /etc/rc.d:
637	rm /etc/rc.d/* && mergemaster -i
638
63920120109:
640	panic(9) now stops other CPUs in the SMP systems, disables interrupts
641	on the current CPU and prevents other threads from running.
642	This behavior can be reverted using the kern.stop_scheduler_on_panic
643	tunable/sysctl.
644	The new behavior can be incompatible with kern.sync_on_panic.
645
64620111215:
647	The carp(4) facility has been changed significantly. Configuration
648	of the CARP protocol via ifconfig(8) has changed, as well as format
649	of CARP events submitted to devd(8) has changed. See manual pages
650	for more information. The arpbalance feature of carp(4) is currently
651	not supported anymore.
652
653	Size of struct in_aliasreq, struct in6_aliasreq has changed. User
654	utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
655	need to be recompiled.
656
65720111122:
658	The acpi_wmi(4) status device /dev/wmistat has been renamed to
659	/dev/wmistat0.
660
66120111108:
662	The option VFS_ALLOW_NONMPSAFE option has been added in order to
663	explicitely support non-MPSAFE filesystems.
664	It is on by default for all supported platform at this present
665	time.
666
66720111101:
668	The broken amd(4) driver has been replaced with esp(4) in the amd64,
669	i386 and pc98 GENERIC kernel configuration files.
670
67120110930:
672	sysinstall has been removed
673
67420110923:
675	The stable/9 branch created in subversion.  This corresponds to the
676	RELENG_9 branch in CVS.
677
678COMMON ITEMS:
679
680	General Notes
681	-------------
682	Avoid using make -j when upgrading.  While generally safe, there are
683	sometimes problems using -j to upgrade.  If your upgrade fails with
684	-j, please try again without -j.  From time to time in the past there
685	have been problems using -j with buildworld and/or installworld.  This
686	is especially true when upgrading between "distant" versions (eg one
687	that cross a major release boundary or several minor releases, or when
688	several months have passed on the -current branch).
689
690	Sometimes, obscure build problems are the result of environment
691	poisoning.  This can happen because the make utility reads its
692	environment when searching for values for global variables.  To run
693	your build attempts in an "environmental clean room", prefix all make
694	commands with 'env -i '.  See the env(1) manual page for more details.
695
696	When upgrading from one major version to another it is generally best
697	to upgrade to the latest code in the currently installed branch first,
698	then do an upgrade to the new branch. This is the best-tested upgrade
699	path, and has the highest probability of being successful.  Please try
700	this approach before reporting problems with a major version upgrade.
701
702	When upgrading a live system, having a root shell around before
703	installing anything can help undo problems. Not having a root shell
704	around can lead to problems if pam has changed too much from your
705	starting point to allow continued authentication after the upgrade.
706
707	ZFS notes
708	---------
709	When upgrading the boot ZFS pool to a new version, always follow
710	these two steps:
711
712	1.) recompile and reinstall the ZFS boot loader and boot block
713	(this is part of "make buildworld" and "make installworld")
714
715	2.) update the ZFS boot block on your boot drive
716
717	The following example updates the ZFS boot block on the first
718	partition (freebsd-boot) of a GPT partitioned drive ad0:
719	"gpart bootcode -p /boot/gptzfsboot -i 1 ad0"
720
721	Non-boot pools do not need these updates.
722
723	To build a kernel
724	-----------------
725	If you are updating from a prior version of FreeBSD (even one just
726	a few days old), you should follow this procedure.  It is the most
727	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
728
729	make kernel-toolchain
730	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
731	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
732
733	To test a kernel once
734	---------------------
735	If you just want to boot a kernel once (because you are not sure
736	if it works, or if you want to boot a known bad kernel to provide
737	debugging information) run
738	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
739	nextboot -k testkernel
740
741	To just build a kernel when you know that it won't mess you up
742	--------------------------------------------------------------
743	This assumes you are already running a CURRENT system.  Replace
744	${arch} with the architecture of your machine (e.g. "i386",
745	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
746
747	cd src/sys/${arch}/conf
748	config KERNEL_NAME_HERE
749	cd ../compile/KERNEL_NAME_HERE
750	make depend
751	make
752	make install
753
754	If this fails, go to the "To build a kernel" section.
755
756	To rebuild everything and install it on the current system.
757	-----------------------------------------------------------
758	# Note: sometimes if you are running current you gotta do more than
759	# is listed here if you are upgrading from a really old current.
760
761	<make sure you have good level 0 dumps>
762	make buildworld
763	make kernel KERNCONF=YOUR_KERNEL_HERE
764							[1]
765	<reboot in single user>				[3]
766	mergemaster -Fp					[5]
767	make installworld
768	mergemaster -Fi					[4]
769	make delete-old					[6]
770	<reboot>
771
772	To cross-install current onto a separate partition
773	--------------------------------------------------
774	# In this approach we use a separate partition to hold
775	# current's root, 'usr', and 'var' directories.   A partition
776	# holding "/", "/usr" and "/var" should be about 2GB in
777	# size.
778
779	<make sure you have good level 0 dumps>
780	<boot into -stable>
781	make buildworld
782	make buildkernel KERNCONF=YOUR_KERNEL_HERE
783	<maybe newfs current's root partition>
784	<mount current's root partition on directory ${CURRENT_ROOT}>
785	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
786	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
787	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
788	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
789	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
790	<reboot into current>
791	<do a "native" rebuild/install as described in the previous section>
792	<maybe install compatibility libraries from ports/misc/compat*>
793	<reboot>
794
795
796	To upgrade in-place from stable to current
797	----------------------------------------------
798	<make sure you have good level 0 dumps>
799	make buildworld					[9]
800	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
801							[1]
802	<reboot in single user>				[3]
803	mergemaster -Fp					[5]
804	make installworld
805	mergemaster -Fi					[4]
806	make delete-old					[6]
807	<reboot>
808
809	Make sure that you've read the UPDATING file to understand the
810	tweaks to various things you need.  At this point in the life
811	cycle of current, things change often and you are on your own
812	to cope.  The defaults can also change, so please read ALL of
813	the UPDATING entries.
814
815	Also, if you are tracking -current, you must be subscribed to
816	freebsd-current@freebsd.org.  Make sure that before you update
817	your sources that you have read and understood all the recent
818	messages there.  If in doubt, please track -stable which has
819	much fewer pitfalls.
820
821	[1] If you have third party modules, such as vmware, you
822	should disable them at this point so they don't crash your
823	system on reboot.
824
825	[3] From the bootblocks, boot -s, and then do
826		fsck -p
827		mount -u /
828		mount -a
829		cd src
830		adjkerntz -i		# if CMOS is wall time
831	Also, when doing a major release upgrade, it is required that
832	you boot into single user mode to do the installworld.
833
834	[4] Note: This step is non-optional.  Failure to do this step
835	can result in a significant reduction in the functionality of the
836	system.  Attempting to do it by hand is not recommended and those
837	that pursue this avenue should read this file carefully, as well
838	as the archives of freebsd-current and freebsd-hackers mailing lists
839	for potential gotchas.  The -U option is also useful to consider.
840	See mergemaster(8) for more information.
841
842	[5] Usually this step is a noop.  However, from time to time
843	you may need to do this if you get unknown user in the following
844	step.  It never hurts to do it all the time.  You may need to
845	install a new mergemaster (cd src/usr.sbin/mergemaster && make
846	install) after the buildworld before this step if you last updated
847	from current before 20130425 or from -stable before 20130430.
848
849	[6] This only deletes old files and directories. Old libraries
850	can be deleted by "make delete-old-libs", but you have to make
851	sure that no program is using those libraries anymore.
852
853	[8] In order to have a kernel that can run the 4.x binaries needed to
854	do an installworld, you must include the COMPAT_FREEBSD4 option in
855	your kernel.  Failure to do so may leave you with a system that is
856	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
857	required to run the 5.x binaries on more recent kernels.  And so on
858	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
859
860	Make sure that you merge any new devices from GENERIC since the
861	last time you updated your kernel config file.
862
863	[9] When checking out sources, you must include the -P flag to have
864	cvs prune empty directories.
865
866	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
867	"?=" instead of the "=" assignment operator, so that buildworld can
868	override the CPUTYPE if it needs to.
869
870	MAKEOBJDIRPREFIX must be defined in an environment variable, and
871	not on the command line, or in /etc/make.conf.  buildworld will
872	warn if it is improperly defined.
873FORMAT:
874
875This file contains a list, in reverse chronological order, of major
876breakages in tracking -current.  It is not guaranteed to be a complete
877list of such breakages, and only contains entries since October 10, 2007.
878If you need to see UPDATING entries from before that date, you will need
879to fetch an UPDATING file from an older FreeBSD release.
880
881Copyright information:
882
883Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
884
885Redistribution, publication, translation and use, with or without
886modification, in full or in part, in any form or format of this
887document are permitted without further permission from the author.
888
889THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
890IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
891WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
892DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
893INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
894(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
895SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
896HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
897STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
898IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
899POSSIBILITY OF SUCH DAMAGE.
900
901Contact Warner Losh if you have any questions about your use of
902this document.
903
904$FreeBSD$
905