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