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