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